beautypg.com

Onebox modules, Retrieving onebox module names – Google Search Appliance Administrative API Developers Guide: Protocol User Manual

Page 28

background image

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

28

OneBox Modules

Retrieve the names of and delete OneBox modules from a search appliance using the onebox feed.

Note: This API does not support adding, updating, or viewing detailed configuration information for a
OneBox module.

Retrieving OneBox Module Names

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

http://Search_Appliance:8000/feeds/onebox

The following example retrieves the current OneBox values for the search appliance:


xmlns:openSearch=’http://a9.com/-/spec/opensearchrss/1.0/’
xmlns:gsa=’http://schemas.google.com/gsa/2007’>
http://gsa:8000/feeds/onebox
2008-12-15T13:37:36.678Z

type=’application/atom+xml’ href=’http://gsa:8000/feeds/onebox’/>

href=’http://gsa:8000/feeds/onebox’/>

Google Search Appliance


1

http://gsa:8000/feeds/onebox/oneboxone
2008-12-15T13:37:36.678Z

href=’http://gsa:8000/feeds/onebox’/>

href=’http://gsa:8000/feeds/onebox’/>

oneboxone

http://gsa:8000/feeds/onebox/oneboxtwo
2008-12-15T13:37:36.678Z

href=’http://gsa:8000/feeds/onebox’/>

href=’http://gsa:8000/feeds/onebox’/>

oneboxtwo

Note: Because this API does not support retrieving detailed OneBox configuration information,
retrieving the onebox feed supplies only the names of each OneBox module.

Property

Description

logContent

The log content for OneBox logs.