Update Collection Settings - /rest/collection/updateSettings

JSON Payload

JSON Fields

Attributes

Value

apikey

API key accessible in the Dasboard > Collections > License. It is also present in the config.xml file

colname

Name of the Collection

keyword-in-context

Value is set to Yes or No to enable or disable keyword-in-context display respectively.
The keyword-in-context returns search results with the description displayed from content areas where the search term occurs. To enable give yes and to disable give no

remove-duplicates

Value is set to Yes or No to remove duplicate or allow duplicates documents while indexing respectively.

boost

Boost search terms for the collection by setting a value greater than 1 (maximum value 9999).

stemming

Value is set to Yes or No to enable or disable stemming respectively.
When stemming is enabled, inflected words are reduced to root form. For example, "running", "runs", and "ran" are the inflected form of run.

logging

Value is set to Yes or No to enable or disable logging respectively

html-settings

description

This description setting configures the HTML parser to read the description for a document. You can specify any one of the following HTML tags to be read as description
Description, h1, h2, h3, h4 ,h5, h6

max-doc-age

Specifies the maximum allowable age in days of a document in the collection. By giving -1 we do not specify any maximum allowable age.

max-doc-size

Specifies the maximum allowable size in kilobytes of a document in the collection. By giving -1 we do not specify any maximum document size.

spider-max depth

Specifies the maximum depth the spider is allowed to proceed to index documents. Value can be specified from 1..10.

spider-max-delay

Specifies the wait time in milliseconds for the spider between HTTP requests to a web server. By giving 0 we specify no delay.

user-agent

Specifies the name under which the spider requests documents from a webserver.

referer

Specifies the URL value set in the request headers to specify where the user agent previously visited.

ignore-robots

Value is set to Yes or No to tell the spider to obey robot rules or not.

follow-sitemap

Value is set to Yes or No to tell the spider whether sitemaps alone can be indexed, or if all of the URLs have to be indexed respectively.

follow-redirect

Is set to Yes or No to instruct the spider to automatically follow redirects or not.

basic-auth-settings

username

These settings help in indexing content secured by HTTP Basic authentication.
Username for basic authentication has to be specified for this attribute.

password

Password for basic authentication has to be specified for this attribute.

form-auth-settings

form-url

These settings help in indexing content protected using form based authentication.
form-url is the ACTION URL of the authentication HTML form.

Form-action

Specifies whether the form action is a POST or GET.

form – name, value

The set of name/value pairs that are required. For example, username and password information for authentication are set here.
Example
Name,Value
Web User,myself
Password,abc123
Login,true

proxy-settings

server-url

These settings help in indexing content through proxy servers.
This specifies the URL to access the proxy server.

username

When the proxy server requires authentication, set the username.

password

Set the password.

Language
Click Try It! to start a request and see the response here!