web-category

Web-Category Commands.

web-category Specification

Type Configuration Resource
Element Name web-category
Element URI /axapi/v3/web-category
Element Attributes web-category_attributes
Operational Data URI /axapi/v3/web-category/oper
Schema web-category schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/web-category

web-category Attributes

Get Object

GET

/axapi/v3/web-category

web-category Attributes

Modify Object

POST

/axapi/v3/web-category

web-category Attributes

Replace Object

PUT

/axapi/v3/web-category

web-category Attributes

Delete Object

DELETE

/axapi/v3/web-category

web-category Attributes

Get Oper

GET

/axapi/v3/web-category/oper

operational data

web-category Attributes

category-list-list

Description: category-list-list is a JSON List . Please see below for category-list-list

Type: List

Reference Object: /axapi/v3/web-category/category-list/{name}

cloud-query-disable

Description: Disables cloud queries for URLs that are not present in the local cache or database.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

database-server

Description: URL of the BrightCloud database server. For example: database.brightcloud.com

Type: string

db-update-time

Description: Time of day at which ACOS requests an updated web category database from the BrightCloud server, in the format 00:00.

Type: string

Format: time-hhmm

enable

Description: Enable the operation of web category classification.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

port

Description: Protocol port on which the BrightCloud server listens for requests.

Type: number

Range: 1-65535

Default: 80

remote-syslog-enable

Description: Enables data plane logging to a remote syslog server.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rtu-update-disable

Description: Disables realtime updates. Enabled by default. ACOS periodically checks for realtime updates based on the rtu-update-interval setting and adds them to the service cache.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rtu-update-interval

Description: Interval in minutes at which to periodically check for real time updates.

Type: number

Range: 10-14400

Default: 60

server

Description: URL of the BrightCloud query server. For example: service.brightcloud.com

Type: string

server-timeout

Description: Maximum number of seconds to wait for the BrightCloud server to respond to a query from ACOS. You can specify 1-300 seconds. If a reply is not received before the timeout, ACOS terminates the connection with the server.

Type: number

Range: 1-300

Default: 30

ssl-port

Description: Protocol port on which the BrightCloud server listens for SSL traffic.

Type: number

Range: 1-65535

Default: 443

use-mgmt-port

Description: Uses the management interface for all communication with BrightCloud servers, including downloading the database and any lookup queries.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

category-list-list

Specification
Type list
Block object keys

abortion

Description: Category Abortion

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

adult-and-pornography

Description: Category Adult and Pornography

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

alochol-and-tobacco

Description: Category Alcohol and Tobacco

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

auctions

Description: Category Auctions

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

bot-nets

Description: Category Bot Nets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

business-and-economy

Description: Category Business and Economy

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cdns

Description: Category CDNs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cheating

Description: Category Cheating

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

computer-and-internet-info

Description: Category Computer and Internet Info

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

computer-and-internet-security

Description: Category Computer and Internet Security

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

confirmed-spam-sources

Description: Category Confirmed SPAM Sources

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cult-and-occult

Description: Category Cult and Occult

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dating

Description: Category Dating

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dead-sites

Description: Category Dead Sites (db Ops only)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

drugs

Description: Category Abused Drugs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dynamic-comment

Description: Category Dynamic Comment

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

educational-institutions

Description: Category Educational Institutions

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

entertainment-and-arts

Description: Category Entertainment and Arts

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fashion-and-beauty

Description: Category Fashion and Beauty

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

financial-services

Description: Category Financial Services

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

food-and-dining

Description: Category Food and Dining

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

gambling

Description: Category Gambling

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

games

Description: Category Games

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

government

Description: Category Government

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

gross

Description: Category Gross

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

hacking

Description: Category Hacking

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

hate-and-racism

Description: Category Hate and Racism

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

health-and-medicine

Description: Category Health and Medicine

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

home-and-garden

Description: Category Home and Garden

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

hunting-and-fishing

Description: Category Hunting and Fishing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

illegal

Description: Category Illegal

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

image-and-video-search

Description: Category Image and Video Search

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

internet-communications

Description: Category Internet Communications

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

internet-portals

Description: Category Internet Portals

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

job-search

Description: Category Job Search

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

keyloggers-and-monitoring

Description: Category Keyloggers and Monitoring

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

kids

Description: Category Kids

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

legal

Description: Category Legal

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

local-information

Description: Category Local Information

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

malware-sites

Description: Category Malware Sites

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

marijuana

Description: Category Marijuana

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

military

Description: Category Military

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

motor-vehicles

Description: Category Motor Vehicles

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

music

Description: Category Music

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

name

Description: Web Category List name

Type: string

Format: string-rlx

news-and-media

Description: Category News and Media

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

nudity

Description: Category Nudity

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

online-greeting-cards

Description: Category Online Greeting cards

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

open-http-proxies

Description: Category Open HTTP Proxies

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

parked-domains

Description: Category Parked Domains

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

pay-to-surf

Description: Category Pay to Surf

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

peer-to-peer

Description: Category Peer to Peer

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

personal-sites-and-blogs

Description: Category Personal sites and Blogs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

personal-storage

Description: Category Personal Storage

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

philosophy-and-politics

Description: Category Philosophy and Political Advocacy

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

phishing-and-other-fraud

Description: Category Phishing and Other Frauds

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

private-ip-addresses

Description: Category Private IP Addresses

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

proxy-avoid-and-anonymizers

Description: Category Proxy Avoid and Anonymizers

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

questionable

Description: Category Questionable

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

real-estate

Description: Category Real Estate

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

recreation-and-hobbies

Description: Category Recreation and Hobbies

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

reference-and-research

Description: Category Reference and Research

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

religion

Description: Category Religion

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l67_sampling-enable

Type: List

search-engines

Description: Category Search Engines

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sex-education

Description: Category Sex Education

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

shareware-and-freeware

Description: Category Shareware and Freeware

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

shopping

Description: Category Shopping

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

social-network

Description: Category Social Network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

society

Description: Category Society

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

spam-urls

Description: Category SPAM URLs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sports

Description: Category Sports

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

spyware-and-adware

Description: Category Spyware and Adware

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

stock-advice-and-tools

Description: Category Stock Advice and Tools

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

streaming-media

Description: Category Streaming Media

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

swimsuits-and-intimate-apparel

Description: Category Swimsuits and Intimate Apparel

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

training-and-tools

Description: Category Training and Tools

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

translation

Description: Category Translation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

travel

Description: Category Travel

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uncategorized

Description: Uncategorized URLs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

unconfirmed-spam-sources

Description: Category Unconfirmed SPAM Sources

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

violence

Description: Category Violence

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

weapons

Description: Category Weapons

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

web-advertisements

Description: Category Web Advertisements

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

web-based-email

Description: Category Web based email

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

web-hosting-sites

Description: Category Web Hosting Sites

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

category-list-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘uncategorized’: uncategorized category; ‘real-estate’: real estate category; ‘computer-and-internet-security’: computer and internet security category; ‘financial-services’: financial services category; ‘business-and-economy’: business and economy category; ‘computer-and-internet-info’: computer and internet info category; ‘auctions’: auctions category; ‘shopping’: shopping category; ‘cult-and-occult’: cult and occult category; ‘travel’: travel category; ‘drugs’: drugs category; ‘adult-and-pornography’: adult and pornography category; ‘home-and-garden’: home and garden category; ‘military’: military category; ‘social-network’: social network category; ‘dead-sites’: dead sites category; ‘stock-advice-and-tools’: stock advice and tools category; ‘training-and-tools’: training and tools category; ‘dating’: dating category; ‘sex-education’: sex education category; ‘religion’: religion category; ‘entertainment-and-arts’: entertainment and arts category; ‘personal-sites-and-blogs’: personal sites and blogs category; ‘legal’: legal category; ‘local-information’: local information category; ‘streaming-media’: streaming media category; ‘job-search’: job search category; ‘gambling’: gambling category; ‘translation’: translation category; ‘reference-and-research’: reference and research category; ‘shareware-and-freeware’: shareware and freeware category; ‘peer-to-peer’: peer to peer category; ‘marijuana’: marijuana category; ‘hacking’: hacking category; ‘games’: games category; ‘philosophy-and-politics’: philosophy and politics category; ‘weapons’: weapons category; ‘pay-to-surf’: pay to surf category; ‘hunting-and-fishing’: hunting and fishing category; ‘society’: society category; ‘educational-institutions’: educational institutions category; ‘online-greeting-cards’: online greeting cards category; ‘sports’: sports category; ‘swimsuits-and-intimate-apparel’: swimsuits and intimate apparel category; ‘questionable’: questionable category; ‘kids’: kids category; ‘hate-and-racism’: hate and racism category; ‘personal-storage’: personal storage category; ‘violence’: violence category; ‘keyloggers-and-monitoring’: keyloggers and monitoring category; ‘search-engines’: search engines category; ‘internet-portals’: internet portals category; ‘web-advertisements’: web advertisements category; ‘cheating’: cheating category; ‘gross’: gross category; ‘web-based-email’: web based email category; ‘malware-sites’: malware sites category; ‘phishing-and-other-fraud’: phishing and other fraud category; ‘proxy-avoid-and-anonymizers’: proxy avoid and anonymizers category; ‘spyware-and-adware’: spyware and adware category; ‘music’: music category; ‘government’: government category; ‘nudity’: nudity category; ‘news-and-media’: news and media category; ‘illegal’: illegal category; ‘CDNs’: content delivery networks category; ‘internet-communications’: internet communications category; ‘bot-nets’: bot nets category; ‘abortion’: abortion category; ‘health-and-medicine’: health and medicine category; ‘confirmed-SPAM-sources’: confirmed SPAM sources category; ‘SPAM-URLs’: SPAM URLs category; ‘unconfirmed-SPAM-sources’: unconfirmed SPAM sources category; ‘open-HTTP-proxies’: open HTTP proxies category; ‘dynamic-comment’: dynamic comment category; ‘parked-domains’: parked domains category; ‘alochol-and-tobacco’: alcohol and tobacco category; ‘private-IP-addresses’: private IP addresses category; ‘image-and-video-search’: image and video search category; ‘fashion-and-beauty’: fashion and beauty category; ‘recreation-and-hobbies’: recreation and hobbies category; ‘motor-vehicles’: motor vehicles category; ‘web-hosting-sites’: web hosting sites category; ‘food-and-dining’: food and dining category;

Type: string

Supported Values: all, uncategorized, real-estate, computer-and-internet-security, financial-services, business-and-economy, computer-and-internet-info, auctions, shopping, cult-and-occult, travel, drugs, adult-and-pornography, home-and-garden, military, social-network, dead-sites, stock-advice-and-tools, training-and-tools, dating, sex-education, religion, entertainment-and-arts, personal-sites-and-blogs, legal, local-information, streaming-media, job-search, gambling, translation, reference-and-research, shareware-and-freeware, peer-to-peer, marijuana, hacking, games, philosophy-and-politics, weapons, pay-to-surf, hunting-and-fishing, society, educational-institutions, online-greeting-cards, sports, swimsuits-and-intimate-apparel, questionable, kids, hate-and-racism, personal-storage, violence, keyloggers-and-monitoring, search-engines, internet-portals, web-advertisements, cheating, gross, web-based-email, malware-sites, phishing-and-other-fraud, proxy-avoid-and-anonymizers, spyware-and-adware, music, government, nudity, news-and-media, illegal, CDNs, internet-communications, bot-nets, abortion, health-and-medicine, confirmed-SPAM-sources, SPAM-URLs, unconfirmed-SPAM-sources, open-HTTP-proxies, dynamic-comment, parked-domains, alochol-and-tobacco, private-IP-addresses, image-and-video-search, fashion-and-beauty, recreation-and-hobbies, motor-vehicles, web-hosting-sites, food-and-dining

operational data

Name Type Description
web-cat-connection-status string web-cat-connection-status
web-cat-version string web-cat-version
web-cat-database-version number web-cat-database-version
web-cat-database-size string web-cat-database-size
web-cat-next-update-time string web-cat-next-update-time
web-cat-database-name string web-cat-database-name
web-cat-last-successful-connection string web-cat-last-successful-connection
web-cat-last-date-time string web-cat-last-date-time
web-cat-failure-reason string web-cat-failure-reason