Globus Search

Globus Search is a service which allows users to store data with visibility controls based on Globus Identities and Groups. Data may be public, or only visible to certain sets of users. The primary features of the service are APIs for storing and managing data, and visibility-filtered query APIs.

Globus Search Overview

An overview of the Globus Search service’s capabilities, basic concepts, and terminology

API Usage

Basic info on how to use the Search API over HTTP, how to authorize API calls, and the Globus Search scopes

API Reference

A complete reference of all API methods. There is also an autogenerated reference available from the service itself: Autogenerated Docs.

Guides

Guide documents which cover specific workflows. In particular, the Searchable Files guide, with its accompanying Demo Application can be a good starting point for new users of Globus Search.

Globus Search Clients

The following client tools are distributed for use with the Globus Search API.

  • The Python Globus SDK contains two components for use with Globus Search.

    • globus_sdk.SearchClient is a client class with methods for calling Search

    • globus_sdk.SearchQuery is a helper class for building Search Query data for use with the POST /v1/index/<index_id>/search API

  • The Globus CLI supports querying, ingesting, deleting, and managing resources in Globus Search. For more detail, see the list of supported commands.