Update URL Category

Updates the URL category for the specified ID. If keywords are included within the request, then they replace existing ones for the specified URL category. If the keywords attribute is not included the request, the existing keywords are retained.

You can perform a full update for the specified URL category. However, if attributes are omitted within the update request, the values for those attributes are cleared.

You can also perform an incremental update, to add or remove URLs, for the specified URL category using the action parameter. To learn more, see URL Categories Use Cases.

External Documentation

To learn more, visit the Zscaler Internet Access documentation.

​

Basic Parameters

Parameter	Description
Action	The action applied to the URL category (i.e. add or remove from category list). To learn more, see URL Categories Use Cases.
Categorized Urls	A comma-separated or a JSON list of URLs added to a custom URL category, will also remain linked to their original parent URL category. For more information, refer to Zscaler Internet Access’s Documentation.
Category ID	The unique identifier for the URL category.
Configured Name	Name of the URL category.
Custom Category	Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
IP Ranges	A comma-separated or a JSON list of custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and Retaining Parent custom IP address ranges can be added, per organization, across all categories.
Keywords	A comma-separated or a JSON list of custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories.
Retained Parent Category Keywords	A comma-separated or a JSON list of retained custom keywords from the parent URL category that is associated to a URL category. Up to 2048 retained parent keywords can be added per organization across all categories.
Super Category	Super category of the URL category.
URL Category	The URL category.
URL Category Description	Description of the URL category. Contains tag name and needs to be localized on client side if Custom Category is set to false, else it contains the user-entered description which does not have localization support.
URL Category Type	Type of the custom categories.
URLs	A comma-separated or a JSON list of custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories.

​

Advanced Parameters

Parameter	Description
Custom IP Ranges Count	The number of custom IP address ranges associated to the URL category.
Custom URLs Count	The number of custom URLs associated to the URL category.
Editable	Value is set to true for custom URL category when the user has edit permission.
Parent Retained IP Ranges	A comma-separated or a JSON list of the retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and Retaining Parent custom IP address ranges can be added, per organization, across all categories.
Parent Retained IP Ranges Count	The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
Parent Retained URLs Count	The number of custom URLs associated to the URL category, that also need to be retained under the original parent category.
Retain Parent Keyword Count	Count of total keywords with retain parent category.
Retain Parent Url Count	Count of URLs with retain parent category.
Scopes	Scopes of the custom categories. For more information about the structure of this parameter, please refer to Zscaler Internet Access’s Documentation. Example: “scopes”: [ { “scopeGroupMemberEntities”: [ { “id”: 0, “name”: “string”, “externalId”: “string”, “extensions”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } } ], “Type”: “ORGANIZATION”, “ScopeEntities”: [ { “id”: 0, “name”: “string”, “externalId”: “string”, “extensions”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } } ] } ]
Total Keyword Count	Total keyword count for the category.
Total Url Count	Custom URL count for the category.

​

Example Output

{
	"id": "ANY",
	"configuredName": "string",
	"superCategory": "ANY",
	"keywords": [
		"string"
	],
	"keywordsRetainingParentCategory": [
		"string"
	],
	"urls": [
		"string"
	],
	"dbCategorizedUrls": [
		"string"
	],
	"ipRanges": [
		"string"
	],
	"ipRangesRetainingParentCategory": [
		"string"
	],
	"customCategory": false,
	"scopes": [
		{
			"scopeGroupMemberEntities": [
				{
					"id": 0,
					"name": "string",
					"extensions": {
						"additionalProp1": "string",
						"additionalProp2": "string",
						"additionalProp3": "string"
					}
				}
			],
			"Type": "ORGANIZATION",
			"ScopeEntities": [
				{
					"id": 0,
					"name": "string",
					"extensions": {
						"additionalProp1": "string",
						"additionalProp2": "string",
						"additionalProp3": "string"
					}
				}
			]
		}
	],
	"editable": false,
	"description": "string",
	"type": "URL_CATEGORY",
	"urlKeywordCounts": {
		"totalUrlCount": 0,
		"retainParentUrlCount": 0,
		"totalKeywordCount": 0,
		"retainParentKeywordCount": 0
	},
	"customUrlsCount": 0,
	"urlsRetainingParentCategoryCount": 0,
	"customIpRangesCount": 0,
	"ipRangesRetainingParentCategoryCount": 0
}