zia.URLCategoriesPredefined

• Official documentation
• API documentation

The zia_url_categories_predefined resource allows you to manage mutable fields of existing predefined URL categories. Predefined URL categories are built-in to the Zscaler platform and cannot be created or deleted — only specific fields can be updated.

NOTE: This an Early Access feature.

This resource is designed for use cases where you need to add custom URLs, keywords, or IP ranges to a predefined category such as FINANCE, CORPORATE_MARKETING, etc.

For managing custom URL categories (full CRUD lifecycle), use the zia.URLCategories resource instead.

How This Resource Works

Unlike standard Terraform resources, predefined URL categories have a unique lifecycle:

• No creation — The predefined category already exists on the Zscaler platform. The Create operation issues a PUT to update the category’s mutable fields.
• No deletion — Predefined categories cannot be removed. Running terraform destroy simply removes the resource from state without making any API calls.
• Incremental updates — The provider uses incremental ADD_TO_LIST and REMOVE_FROM_LIST API operations for all list fields (urls, ip_ranges, keywords, keywords_retaining_parent_category, ip_ranges_retaining_parent_category). This means the provider compares the current API state against the desired Terraform configuration and issues targeted add/remove calls rather than a full replacement.

⚠️ IMPORTANT: The description attribute is not supported by this resource. Although the API accepts a description in the PUT payload, the value is not returned in the GET response for predefined categories, which would cause persistent state drift. If you need to set a description on a predefined category, use the ZIA Admin Portal directly.

Example Usage

Adding Custom URLs

resource "zia_url_categories_predefined" "education" {
  name = "EDUCATION"
  urls = [
    ".internal-learning.example.com",
    ".corporate-training.example.com",
  ]
}

Adding Keywords And IP Ranges

resource "zia_url_categories_predefined" "finance" {
  name = "FINANCE"
  keywords = [
    "internal-trading",
    "corporate-finance",
  ]
  ip_ranges = [
    "10.0.0.0/8",
    "172.16.0.0/12",
  ]
}

URLs Retaining Parent Category

resource "zia_url_categories_predefined" "corporate_marketing" {
  name = "CORPORATE_MARKETING"
  urls = [
    ".marketing-internal.example.com",
  ]
  urls_retaining_parent_category = [
    ".brand-portal.example.com",
  ]
  keywords_retaining_parent_category = [
    "brand-assets",
  ]
}

Destroy Behavior

⚠️ This resource does not support deletion. Predefined URL categories are built-in to the Zscaler platform and cannot be removed.

When you run terraform destroy or remove this resource from your configuration:

1. The resource is removed from the Terraform state file.
2. No API call is made — the predefined category remains unchanged on the Zscaler platform.
3. Any custom URLs, keywords, or IP ranges that were added will persist on the predefined category.

If you need to remove custom URLs, keywords, or IP ranges from a predefined category, update the resource to set the fields to empty before destroying:

resource "zia_url_categories_predefined" "education" {
  name      = "EDUCATION"
  urls      = []
  keywords  = []
  ip_ranges = []
}

Then run pulumi up to clear the items, followed by terraform destroy to remove from state.

Create URLCategoriesPredefined Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new URLCategoriesPredefined(name: string, args?: URLCategoriesPredefinedArgs, opts?: CustomResourceOptions);

@overload
def URLCategoriesPredefined(resource_name: str,
                            args: Optional[URLCategoriesPredefinedArgs] = None,
                            opts: Optional[ResourceOptions] = None)

@overload
def URLCategoriesPredefined(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            ip_ranges: Optional[Sequence[str]] = None,
                            ip_ranges_retaining_parent_categories: Optional[Sequence[str]] = None,
                            keywords: Optional[Sequence[str]] = None,
                            keywords_retaining_parent_categories: Optional[Sequence[str]] = None,
                            name: Optional[str] = None,
                            urls: Optional[Sequence[str]] = None,
                            urls_retaining_parent_categories: Optional[Sequence[str]] = None)

func NewURLCategoriesPredefined(ctx *Context, name string, args *URLCategoriesPredefinedArgs, opts ...ResourceOption) (*URLCategoriesPredefined, error)

public URLCategoriesPredefined(string name, URLCategoriesPredefinedArgs? args = null, CustomResourceOptions? opts = null)

public URLCategoriesPredefined(String name, URLCategoriesPredefinedArgs args)
public URLCategoriesPredefined(String name, URLCategoriesPredefinedArgs args, CustomResourceOptions options)

type: zia:URLCategoriesPredefined
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Constructor example

The following reference example uses placeholder values for all input properties.

var urlcategoriesPredefinedResource = new Zia.URLCategoriesPredefined("urlcategoriesPredefinedResource", new()
{
    IpRanges = new[]
    {
        "string",
    },
    IpRangesRetainingParentCategories = new[]
    {
        "string",
    },
    Keywords = new[]
    {
        "string",
    },
    KeywordsRetainingParentCategories = new[]
    {
        "string",
    },
    Name = "string",
    Urls = new[]
    {
        "string",
    },
    UrlsRetainingParentCategories = new[]
    {
        "string",
    },
});

example, err := zia.NewURLCategoriesPredefined(ctx, "urlcategoriesPredefinedResource", &zia.URLCategoriesPredefinedArgs{
	IpRanges: pulumi.StringArray{
		pulumi.String("string"),
	},
	IpRangesRetainingParentCategories: pulumi.StringArray{
		pulumi.String("string"),
	},
	Keywords: pulumi.StringArray{
		pulumi.String("string"),
	},
	KeywordsRetainingParentCategories: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Urls: pulumi.StringArray{
		pulumi.String("string"),
	},
	UrlsRetainingParentCategories: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var urlcategoriesPredefinedResource = new URLCategoriesPredefined("urlcategoriesPredefinedResource", URLCategoriesPredefinedArgs.builder()
    .ipRanges("string")
    .ipRangesRetainingParentCategories("string")
    .keywords("string")
    .keywordsRetainingParentCategories("string")
    .name("string")
    .urls("string")
    .urlsRetainingParentCategories("string")
    .build());

urlcategories_predefined_resource = zia.URLCategoriesPredefined("urlcategoriesPredefinedResource",
    ip_ranges=["string"],
    ip_ranges_retaining_parent_categories=["string"],
    keywords=["string"],
    keywords_retaining_parent_categories=["string"],
    name="string",
    urls=["string"],
    urls_retaining_parent_categories=["string"])

const urlcategoriesPredefinedResource = new zia.URLCategoriesPredefined("urlcategoriesPredefinedResource", {
    ipRanges: ["string"],
    ipRangesRetainingParentCategories: ["string"],
    keywords: ["string"],
    keywordsRetainingParentCategories: ["string"],
    name: "string",
    urls: ["string"],
    urlsRetainingParentCategories: ["string"],
});

type: zia:URLCategoriesPredefined
properties:
    ipRanges:
        - string
    ipRangesRetainingParentCategories:
        - string
    keywords:
        - string
    keywordsRetainingParentCategories:
        - string
    name: string
    urls:
        - string
    urlsRetainingParentCategories:
        - string

URLCategoriesPredefined Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The URLCategoriesPredefined resource accepts the following input properties:

Outputs

All input properties are implicitly available as output properties. Additionally, the URLCategoriesPredefined resource produces the following output properties:

Look up Existing URLCategoriesPredefined Resource

Get an existing URLCategoriesPredefined resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: URLCategoriesPredefinedState, opts?: CustomResourceOptions): URLCategoriesPredefined

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        category_id: Optional[str] = None,
        configured_name: Optional[str] = None,
        custom_ip_ranges_count: Optional[int] = None,
        custom_urls_count: Optional[int] = None,
        db_categorized_urls: Optional[Sequence[str]] = None,
        editable: Optional[bool] = None,
        ip_ranges: Optional[Sequence[str]] = None,
        ip_ranges_retaining_parent_categories: Optional[Sequence[str]] = None,
        ip_ranges_retaining_parent_category_count: Optional[int] = None,
        keywords: Optional[Sequence[str]] = None,
        keywords_retaining_parent_categories: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        super_category: Optional[str] = None,
        type: Optional[str] = None,
        url_keyword_counts: Optional[Sequence[URLCategoriesPredefinedUrlKeywordCountArgs]] = None,
        url_type: Optional[str] = None,
        urls: Optional[Sequence[str]] = None,
        urls_retaining_parent_categories: Optional[Sequence[str]] = None,
        urls_retaining_parent_category_count: Optional[int] = None,
        val: Optional[int] = None) -> URLCategoriesPredefined

func GetURLCategoriesPredefined(ctx *Context, name string, id IDInput, state *URLCategoriesPredefinedState, opts ...ResourceOption) (*URLCategoriesPredefined, error)

public static URLCategoriesPredefined Get(string name, Input<string> id, URLCategoriesPredefinedState? state, CustomResourceOptions? opts = null)

public static URLCategoriesPredefined get(String name, Output<String> id, URLCategoriesPredefinedState state, CustomResourceOptions options)

resources:  _:    type: zia:URLCategoriesPredefined    get:      id: ${id}

Supporting Types

URLCategoriesPredefinedUrlKeywordCount, URLCategoriesPredefinedUrlKeywordCountArgs

Import

Predefined URL categories can be imported by using the predefined category ID or display name as the import ID.

For example:

$ pulumi import zia:index/uRLCategoriesPredefined:URLCategoriesPredefined example EDUCATION

or

$ pulumi import zia:index/uRLCategoriesPredefined:URLCategoriesPredefined example FINANCE

⚠️ NOTE: This resource only supports importing predefined URL categories. For custom URL categories, use the zia.URLCategories resource.

Important Import Considerations

When importing a predefined category that already has custom URLs, keywords, or IP ranges configured (e.g., via the ZIA Admin Portal), those existing items will be captured in the Terraform state. If your HCL configuration does not include those items, the next pulumi up will attempt to remove them to match the desired state defined in your configuration.

To avoid unintended removals after import, ensure your HCL includes all existing custom items that should be retained, or review the plan output carefully before applying.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository

zia zscaler/pulumi-zia

License

MIT

Notes

This Pulumi package is based on the zia Terraform Provider.