ip_profiles

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

Overview

Name	ip_profiles
Type	Resource
Id	cloudflare.zero_trust.ip_profiles

Fields

The following fields are returned by SELECT queries:

get

Get Device IP profile response.

Name	Datatype	Description
id	string	The ID of the Device IP profile. (example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415)
name	string	A user-friendly name for the Device IP profile. (example: IPv4 Cloudflare Source IPs)
subnet_id	string	The ID of the Subnet. (example: b70ff985-a4ef-4643-bbbc-4a0ed4fc8415)
created_at	string	The RFC3339Nano timestamp when the Device IP profile was created. (example: 2025-02-14T13:17:00.123456789Z)
description	string	An optional description of the Device IP profile. (example: example comment)
enabled	boolean	Whether the Device IP profile is enabled.
match	string	The wirefilter expression to match registrations. Available values: "identity.name", "identity.email", "identity.groups.id", "identity.groups.name", "identity.groups.email", "identity.saml_attributes". (example: identity.email == "test@cloudflare.com")
precedence	integer	The precedence of the Device IP profile. Lower values indicate higher precedence. Device IP profile will be evaluated in ascending order of this field.
updated_at	string	The RFC3339Nano timestamp when the Device IP profile was last updated. (example: 2025-02-14T13:17:00.123456789Z)

list

List Device IP profiles response.

Name	Datatype	Description
id	string	The ID of the Device IP profile. (example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415)
name	string	A user-friendly name for the Device IP profile. (example: IPv4 Cloudflare Source IPs)
subnet_id	string	The ID of the Subnet. (example: b70ff985-a4ef-4643-bbbc-4a0ed4fc8415)
created_at	string	The RFC3339Nano timestamp when the Device IP profile was created. (example: 2025-02-14T13:17:00.123456789Z)
description	string	An optional description of the Device IP profile. (example: example comment)
enabled	boolean	Whether the Device IP profile is enabled.
match	string	The wirefilter expression to match registrations. Available values: "identity.name", "identity.email", "identity.groups.id", "identity.groups.name", "identity.groups.email", "identity.saml_attributes". (example: identity.email == "test@cloudflare.com")
precedence	integer	The precedence of the Device IP profile. Lower values indicate higher precedence. Device IP profile will be evaluated in ascending order of this field.
updated_at	string	The RFC3339Nano timestamp when the Device IP profile was last updated. (example: 2025-02-14T13:17:00.123456789Z)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, profile_id		Fetches a single WARP Device IP profile.
list	select	account_id	per_page	Lists WARP Device IP profiles.
create	insert	account_id, name, subnet_id, precedence, match		Creates a WARP Device IP profile. Currently, only IPv4 Device subnets can be associated.
update	update	account_id, profile_id		Updates a WARP Device IP profile. Currently, only IPv4 Device subnets can be associated.
delete	delete	account_id, profile_id		Delete a WARP Device IP profile.

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.
profile_id	string
per_page	integer	The number of IP profiles to return per page.

SELECT examples

get

Fetches a single WARP Device IP profile.

SELECT
id,
name,
subnet_id,
created_at,
description,
enabled,
match,
precedence,
updated_at
FROM cloudflare.zero_trust.ip_profiles
WHERE account_id = '{{ account_id }}' -- required
AND profile_id = '{{ profile_id }}' -- required
;

list

Lists WARP Device IP profiles.

SELECT
id,
name,
subnet_id,
created_at,
description,
enabled,
match,
precedence,
updated_at
FROM cloudflare.zero_trust.ip_profiles
WHERE account_id = '{{ account_id }}' -- required
AND per_page = '{{ per_page }}'
;

INSERT examples

create

Creates a WARP Device IP profile. Currently, only IPv4 Device subnets can be associated.

INSERT INTO cloudflare.zero_trust.ip_profiles (
description,
enabled,
match,
name,
precedence,
subnet_id,
account_id
)
SELECT 
'{{ description }}',
{{ enabled }},
'{{ match }}' /* required */,
'{{ name }}' /* required */,
{{ precedence }} /* required */,
'{{ subnet_id }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: ip_profiles
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the ip_profiles resource.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of the Device IP profile.
  - name: enabled
    value: {{ enabled }}
    description: |
      Whether the Device IP profile will be applied to matching devices.
    default: true
  - name: match
    value: "{{ match }}"
    description: |
      The wirefilter expression to match registrations. Available values: "identity.name", "identity.email", "identity.groups.id", "identity.groups.name", "identity.groups.email", "identity.saml_attributes".
  - name: name
    value: "{{ name }}"
    description: |
      A user-friendly name for the Device IP profile.
  - name: precedence
    value: {{ precedence }}
    description: |
      The precedence of the Device IP profile. Lower values indicate higher precedence. Device IP profile will be evaluated in ascending order of this field.
  - name: subnet_id
    value: "{{ subnet_id }}"
    description: |
      The ID of the Subnet.

UPDATE examples

update

Updates a WARP Device IP profile. Currently, only IPv4 Device subnets can be associated.

UPDATE cloudflare.zero_trust.ip_profiles
SET 
description = '{{ description }}',
enabled = {{ enabled }},
match = '{{ match }}',
name = '{{ name }}',
precedence = {{ precedence }},
subnet_id = '{{ subnet_id }}'
WHERE 
account_id = '{{ account_id }}' --required
AND profile_id = '{{ profile_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Delete a WARP Device IP profile.

DELETE FROM cloudflare.zero_trust.ip_profiles
WHERE account_id = '{{ account_id }}' --required
AND profile_id = '{{ profile_id }}' --required
;