Onebox settings, Retrieving onebox settings, Updating onebox settings – Google Search Appliance Administrative API Developers Guide: Protocol User Manual

Page 27

background image

Google Search Appliance: Administrative API Developer’s Guide: Protocol

27

OneBox Settings

Retrieve or update a OneBox setting for a search appliance using the oneboxSetting entry of the
config feed.

Retrieving OneBox Settings

To get a OneBox setting for a search appliance, send an authenticated GET request to the config feed
URL:

http://Search_Appliance:8000/feeds/config/oneboxSetting

The following example result is an entry that includes current OneBox setting values for the search
appliance:


xmlns:gsa=’http://schemas.google.com/gsa/2007’>
http://gsa:8000/feeds/config/oneboxSetting
2008-12-12T09:21:47.477Z

href=’http://gsa:8000/feeds/config/oneboxSetting’/>

href=’http://gsa:8000/feeds/config/oneboxSetting’/>

oneboxSetting
2
1000

Updating OneBox Settings

To update the OneBox settings for a search appliance, send an authenticated PUT request to the config
feed URL:

http://Search_Appliance:8000/feeds/config/oneboxSetting

The following example overwrites the OneBox setting specified in the entry to update:

xmlns:gsa=’http://schemas.google.com/gsa/2007’>

http://gsa:8000/feeds/config/oneboxSetting
oneboxSetting
3
2000

Property

Description

maxResults

Maximum number of OneBox results per search.

timeout

OneBox response timeout.