Google Search Appliance Administrative API Developers Guide: Protocol - Manual (Page 44)

Google Search Appliance: Administrative API Developer’s Guide: Protocol 44
Front Ends, Remove URLs, and Relative OneBoxes
Retrieve, update, and delete front ends, remove URLs, and relative OneBox modules for a search
appliance using the frontend feed. A relative OneBox is a OneBox module that you assign to work with
a front end. Remove URLs are URL patterns that you want to exclude from appearing in an index for a
front end.
Retrieving Front Ends, Remove URLs, and Relative OneBoxes
To get front end information for a search appliance, send an authenticated GET request to the frontend
feed URL:
http://Search_Appliance:8000/feeds/frontend
The following result is a feed that includes current front ends values for a search appliance:
xmlns:openSearch=’http://a9.com/-/spec/opensearchrss/1.0/’
xmlns:gsa=’http://schemas.google.com/gsa/2007’>
http://gsa:8000/feeds/frontend
2008-12-15T14:48:14.851Z
href=’http://gsa:8000/feeds/frontend’/>
href=’http://gsa:8000/feeds/frontend’/>
Google Search Appliance
1
http://gsa:8000/feeds/frontend/default_frontend
2008-12-15T14:48:14.851Z
href=’http://gsa:8000/feeds/frontend’/>
href=’http://gsa:8000/feeds/frontend’/>
default_frontend
oneboxone,oneboxtwo
http://www.example.com/
To get the individual front end information for a search appliance, send an authenticated GET request to
the frontend feed URL for the front end name:
http://Search_Appliance:8000/feeds/frontend/Front_End
Property Description
frontendOnebox OneBox modules for a front end. Specify a comma-separated list of
OneBox module names. The OneBox names display in alphabetic order.
removeUrls Remove URLs for a front end.