Search API
  • Globus Search
  • Overview
  • API Usage & Basics
  • Ingest
  • Query
  • Types, Type Detection, and Schemas
  • Error Handling
  • API Reference
    • Batch Delete by Subject
    • Create or Update Entry
    • Delete by Query
    • Delete by Subject
    • Entry Delete
    • Entry Show
    • Index Create
    • Index Delete
    • Index List
    • Index Reopen
    • Index Show
    • Ingest
    • Query - GET
    • Query - POST
    • Role Create
    • Role Delete
    • Role List
    • Scroll Query
    • Subject Show
    • Task List
    • Task Show
  • Guides
    • Geospatial Search
    • Role Based Filtering
    • Searchable Files
  • Globus Search Limits
  • API Change History
Skip to main content
Globus Docs
  • APIs
    Auth Flows Groups Search Timers Transfer Globus Connect Server Compute Helper Pages
  • Applications
    Globus Connect Personal Globus Connect Server Premium Storage Connectors Compute Command Line Interface Python SDK JavaScript SDK
  • Guides
  • Support
    FAQs Mailing Lists Contact Us Check Support Tickets
  1. Home
  2. Globus Services
  3. Globus Search
  4. API Reference

Globus Search API Reference

The Globus Search API covers a variety of activities related to indexing, updating, deleting, and querying search data.

This section of the documentation covers in detail all of the specific methods of the API.

It also documents schemas and datatypes for the API.

Entry and Subject Operations

These APIs provide direct Read and Delete against data within an index.

You should use the Ingest API to create or update data in Search, and only use these APIs to Read or Delete those data.

Access Controls on Entry & Subject Operations

Access to entry create, update and delete APIs may be restricted to certain users. The identity of the caller is determined based on the Bearer token provided to authenticate the API call.

API Methods

Table 1. Query Operations

Get Query

Simple search query

Post Query

Complex search query

Scroll Query

Scrolling query

Table 2. Ingest APIs

Ingest

Submit an ingest task to write data to Search

Table 3. Task APIs

Get Task

View a specific task

Task List

List recent tasks which were submitted for an index

Table 4. Entry Operations

Get Entry

Lookup a single entry

Delete Entry

Delete a single entry

Create or Update Entry

Create or update a single entry

Table 5. Subject Operations

Get Subject

Lookup a single subject

Delete Subject

Delete a single subject

Delete by Query

Delete by Query

Table 6. Index Management

Index Show

View basic information about an index

Index Create

Create a new index

Index Delete

Delete an index

Index Reopen

Reopen an index marked for deletion (non-trial only)

Index List

List indices where you have 'owner', 'admin', or 'writer' permissions

Role List

List roles on an index where you have 'admin' or 'owner'

Role Create

Add a role to an index where you have 'admin' or 'owner'

  • Globus Search
  • Overview
  • API Usage & Basics
  • Ingest
  • Query
  • Types, Type Detection, and Schemas
  • Error Handling
  • API Reference
    • Batch Delete by Subject
    • Create or Update Entry
    • Delete by Query
    • Delete by Subject
    • Entry Delete
    • Entry Show
    • Index Create
    • Index Delete
    • Index List
    • Index Reopen
    • Index Show
    • Ingest
    • Query - GET
    • Query - POST
    • Role Create
    • Role Delete
    • Role List
    • Scroll Query
    • Subject Show
    • Task List
    • Task Show
  • Guides
    • Geospatial Search
    • Role Based Filtering
    • Searchable Files
  • Globus Search Limits
  • API Change History
© 2010- The University of Chicago Legal Privacy Accessibility