gateway_categories

Creates, updates, deletes, gets or lists a gateway_categories resource.

Overview

Name	gateway_categories
Type	Resource
Id	cloudflare.zero_trust.gateway_categories

Fields

The following fields are returned by SELECT queries:

list

List categories response.

Name	Datatype	Description
id	integer	Identify this category. Only one category per ID.
name	string	Specify the category name. (example: Education)
beta	boolean	Indicate whether the category is in beta and subject to change.
class	string	Specify which account types can create policies for this category. blocked Blocks unconditionally for all accounts. removalPending Allows removal from policies but disables addition. noBlock Prevents blocking. (free, premium, blocked, removalPending, noBlock) (example: premium)
description	string	Provide a short summary of domains in the category. (example: Sites related to educational content that are not included in other categories such as Science, Technology or Educational institutions.)
subcategories	array	Provide all subcategories for this category.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id		List all categories.

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.

SELECT examples

list

List all categories.

SELECT
id,
name,
beta,
class,
description,
subcategories
FROM cloudflare.zero_trust.gateway_categories
WHERE account_id = '{{ account_id }}' -- required
;