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

Google Search Appliance: Administrative API Developer’s Guide: Protocol 5
Administrative API
Developer’s Guide: Protocol
Introduction
The Google Search Appliance Administration API enables administrators to configure a search appliance
programmatically. This API provides functions for creating, retrieving, updating, and deleting search
appliance configuration settings.
The Google Search Appliance Administration API follows the principles of the Google Data APIs. Google
Data APIs are based on both the Atom 1.0 and RSS 2.0 syndication formats in addition to the Atom
Publishing Protocol.
The audience for this guide are XML programmers who have access to a Google Search Appliance. The
user name and password for the Admin Console are required to obtain the authentication token
necessary to run applications for this API.
This guide consists of the following sections:
• “Content Sources” on page 11
• “Index” on page 31
• “Search” on page 43
• “Reports” on page 55
• “GSA Unification” on page 65
• “Administration” on page 69
API Operations
To use this API, you can send HTTP requests to a search appliance to instruct the search appliance to
perform a create, retrieve, update, or delete configuration information in the search appliance.
Note: The sections that follow indicate the corresponding Java client library methods. Parallel methods
are also available in other client libraries.
This section explains the different types of operations that the API supports. See also “How the API
Works” on page 7, which identifies the URL that corresponds to each API operation.
The operations are as follows: