ips
Creates, updates, deletes, gets or lists an ips resource.
Overview
| Name | ips |
| Type | Resource |
| Id | cloudflare.zero_trust.ips |
Fields
The following fields are returned by SELECT queries:
- get
Get tunnel route by IP response
| Name | Datatype | Description |
|---|---|---|
id | string | UUID of the route. (example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415) |
tunnel_id | string (uuid) | UUID of the tunnel. (example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415) |
virtual_network_id | string (uuid) | UUID of the virtual network. (example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415, x-stainless-terraform-configurability: computed_optional) |
tunnel_name | string | A user-friendly name for a tunnel. (example: blog) |
virtual_network_name | string | A user-friendly name for the virtual network. (example: us-east-1-vpc) |
comment | string | Optional remark describing the route. (default: , example: Example comment for this route.) |
created_at | string (date-time) | Timestamp of when the resource was created. (example: 2021-01-25T18:22:34.317854Z) |
deleted_at | string (date-time) | Timestamp of when the resource was deleted. If null, the resource has not been deleted. (example: 2009-11-10T23:00:00.000000Z) |
network | string | The private IPv4 or IPv6 range connected by the route, in CIDR notation. (example: 172.16.0.0/16) |
tun_type | string | The type of tunnel. (cfd_tunnel, warp_connector, warp, magic, ip_sec, gre, cni) (example: cfd_tunnel) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | ip, account_id | virtual_network_id, default_virtual_network_fallback | Fetches routes that contain the given IP address. |
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.
| Name | Datatype | Description |
|---|---|---|
account_id | string | The Cloudflare account ID. |
ip | string | |
default_virtual_network_fallback | boolean | When the virtual_network_id parameter is not provided the request filter will default search routes that are in the default virtual network for the account. If this parameter is set to false, the search will include routes that do not have a virtual network. |
virtual_network_id | string (uuid) |
SELECT examples
- get
Fetches routes that contain the given IP address.
SELECT
id,
tunnel_id,
virtual_network_id,
tunnel_name,
virtual_network_name,
comment,
created_at,
deleted_at,
network,
tun_type
FROM cloudflare.zero_trust.ips
WHERE ip = '{{ ip }}' -- required
AND account_id = '{{ account_id }}' -- required
AND virtual_network_id = '{{ virtual_network_id }}'
AND default_virtual_network_fallback = '{{ default_virtual_network_fallback }}'
;