Skip to main content

ips

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

Overview

Nameips
TypeResource
Idcloudflare.addressing.ips

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
updatereplaceip_address, address_map_id, account_idAdd an IP from a prefix owned by the account to a particular address map.
deletedeleteip_address, address_map_id, account_idRemove an IP from a particular address map.

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
account_idstringThe Cloudflare account ID.
address_map_idstring
ip_addressstring

REPLACE examples

Add an IP from a prefix owned by the account to a particular address map.

REPLACE cloudflare.addressing.ips
SET
-- No updatable properties
WHERE
ip_address = '{{ ip_address }}' --required
AND address_map_id = '{{ address_map_id }}' --required
AND account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result_info,
success;

DELETE examples

Remove an IP from a particular address map.

DELETE FROM cloudflare.addressing.ips
WHERE ip_address = '{{ ip_address }}' --required
AND address_map_id = '{{ address_map_id }}' --required
AND account_id = '{{ account_id }}' --required
;