WebCategory

This entity provides the definition of Web Category. It will be used in ACL definition to filter web traffic.

Overview

defaultCategory boolean read only   filterable   orderable  
description string filterable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable   locally unique  
type enum (WEB_DOMAIN_NAME) required   filterable   orderable  
webCategoryIdentifier integer read only   autogenerated   filterable   locally unique  

API Resource

/webcategories/id
delete get put

Parents

/enterprises/id/webcategories
get post
/webdomainnames/id/webcategories
get put

Children

/webcategories/id/metadatas
get post
/webcategories/id/globalmetadatas
get post put

Members

/webcategories/id/webdomainnames
get put

Attributes documentation

defaultCategory boolean read only   filterable   orderable  
Discussion

Indicates if this is a system-defined web category

Charateristics

Default value: false
SDK attribute: defaultCategory

description string filterable  
Discussion

A customer friendly description for this web category

Charateristics

Format: free
Max length: 255
SDK attribute: description

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable   locally unique  
Discussion

A customer friendly name for this web category

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

type enum required   filterable   orderable  
Discussion

Type of the Web Category

Charateristics

Allowed values: WEB_DOMAIN_NAME
Default value: WEB_DOMAIN_NAME
SDK attribute: type

webCategoryIdentifier integer read only   autogenerated   filterable   locally unique  
Discussion

The unique identifier of a web category to be used by NSG

Charateristics

SDK attribute: webCategoryIdentifier