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:
<?xml version=’1.0’ encoding=’UTF-8’?>
<feed xmlns=’http://www.w3.org/2005/Atom’
xmlns:openSearch=’http://a9.com/-/spec/opensearchrss/1.0/’
xmlns:gsa=’http://schemas.google.com/gsa/2007’>
<id>http://gsa:8000/feeds/frontend</id>
<updated>2008-12-15T14:48:14.851Z</updated>
<link rel=’http://schemas.example.com/g/2005#feed’ type=’application/atom+xml’
href=’http://gsa:8000/feeds/frontend’/>
<link rel=’self’ type=’application/atom+xml’
href=’http://gsa:8000/feeds/frontend’/>
<generator version=’0.5’ uri=’http://gsa:8000/gsa’>
Google Search Appliance
</generator>
<openSearch:startIndex>1</openSearch:startIndex>
<entry>
<id>http://gsa:8000/feeds/frontend/default_frontend</id>
<updated>2008-12-15T14:48:14.851Z</updated>
<link rel=’self’ type=’application/atom+xml’
href=’http://gsa:8000/feeds/frontend’/>
<link rel=’edit’ type=’application/atom+xml’
href=’http://gsa:8000/feeds/frontend’/>
<gsa:content name=’entryID’>default_frontend</gsa:content>
<gsa:content name=’frontendOnebox’>oneboxone,oneboxtwo</gsa:content>
<gsa:content name=’removeUrls’>http://www.example.com/</gsa:content>
</entry>
</feed>
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.