Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

urlfilteringparameter

August 17, 2023
Contributed by: 
C

Configuration for URLFILTERING paramter resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
hoursbetweendbupdates Read-write URL Filtering hours between DB updates.

Minimum value = 0

Maximum value = 720
timeofdaytoupdatedb Read-write URL Filtering time of day to update DB.
localdatabasethreads Read-write URL Filtering Local DB number of threads.

Minimum value = 1

Maximum value = 4
cloudhost Read-write URL Filtering Cloud host.
seeddbpath Read-write URL Filtering Seed DB path.
maxnumberofcloudthreads Read-only URL Filtering hours between DB updates.

Minimum value = 1

Maximum value = 128
cloudkeepalivetimeout Read-only URL Filtering Cloud keep alive timeout in msec.

Minimum value = 1000

Maximum value = 600000
cloudserverconnecttimeout Read-only URL Filtering Cloud server connect timeout in msec.

Minimum value = 1000

Maximum value = 600000
clouddblookuptimeout Read-only URL Filtering CloudDB send/receive timeout in msec.

Minimum value = 1000

Maximum value = 600000
proxyhostip Read-only URL Filtering Cloud Proxy HostIp.

Minimum length = 1
proxyport Read-only URL Filtering Cloud Proxy Port.
proxyusername Read-only URL Filtering Cloud Proxy Username.

Minimum length = 1
proxypassword Read-only URL Filtering Cloud Proxy Password.

Minimum length = 1
seeddbsizelevel Read-only URL Filtering Seed DB Size Level to get downloaded.

Minimum value = 1

Maximum value = 5

Operations

(click to see Properties )

  • UPDATE
  • UNSET
  • GET (ALL)

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note: *

Mandatory parameters are marked in red and placeholder content is marked in green

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/urlfilteringparameter

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"urlfilteringparameter":{
      "hoursbetweendbupdates":<Double_value>,
      "timeofdaytoupdatedb":<String_value>,
      "localdatabasethreads":<Double_value>,
      "cloudhost":<String_value>,
      "seeddbpath":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/urlfilteringparameter? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"urlfilteringparameter":{
      "hoursbetweendbupdates":true,
      "timeofdaytoupdatedb":true,
      "localdatabasethreads":true,
      "cloudhost":true,
      "seeddbpath":true
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/urlfilteringparameter

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 


{ "urlfilteringparameter": [ {
      "hoursbetweendbupdates":<Double_value>,
      "timeofdaytoupdatedb":<String_value>,
      "maxnumberofcloudthreads":<Double_value>,
      "cloudkeepalivetimeout":<Double_value>,
      "cloudserverconnecttimeout":<Double_value>,
      "clouddblookuptimeout":<Double_value>,
      "proxyhostip":<String_value>,
      "proxyport":<Double_value>,
      "proxyusername":<String_value>,
      "proxypassword":<String_value>,
      "seeddbsizelevel":<Double_value>,
      "localdatabasethreads":<Double_value>,
      "cloudhost":<String_value>,
      "seeddbpath":<String_value>
}]}

<!--NeedCopy-->
urlfilteringparameter
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.