Search API Menu
  • Globus Search
  • Overview
  • API Usage & Basics
  • Ingest
  • Query
  • Types, Type Detection, and Schemas
  • Error Handling
  • API Reference
    • Create or Update Entry
    • Delete by Query
    • Delete by Subject
    • Delete Entry
    • Get Entry
    • GET Query
    • Get Subject
    • Get Task
    • Index Create (BETA)
    • Index Delete (BETA)
    • Index List
    • Index Reopen (BETA)
    • Ingest
    • POST Query
    • Role Create
    • Role Delete
    • Role List
    • Scroll Query
    • Show Index
    • Task List
  • 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 Transfer Python SDK Helper Pages
  • How To
  • Guides
    Globus Connect Server High Assurance Collections for Protected Data Command Line Interface Premium Storage Connectors Security Modern Research Data Portal
  • Support
    FAQs Mailing Lists Contact Us Check Support Tickets
  1. Home
  2. Globus APIs
  3. Globus Search

API Usage & Basics

Table of Contents
  • 1. Communicating with Globus Search
    • 1.1. URLs
  • 2. Authentication & Authorization
    • 2.1. Authorization Header
    • 2.2. Scopes
    • 2.3. Permissions in Search

The Full API Reference covers all API methods.

It details the request methods, authentication and authorization requirements, and response formats for every supported operation.

All of that documentation has these components as its basis:

1. Communicating with Globus Search

Globus Search is a web API which communicates over the HTTP protocol using a RESTful data model.

1.1. URLs

The Search API is reached at https://search.api.globus.org/

URLs and URIs in this documentation will usually omit this piece, so the text

GET /foo/bar

should be interpreted as referring to an HTTP GET request against

https://search.api.globus.org/foo/bar

1.1.1. Globus Preview URL

In the Globus Preview environment, the Search API can be found at https://search.api.preview.globus.org.

2. Authentication & Authorization

Some features of Search don’t have any authorization or authentication requirements. These can be accessed over HTTPS with no credentials.

API methods are which are documented as requiring authentication must be authenticated with a Globus Auth token. They will document the scopes which they need.

2.1. Authorization Header

Globus Search authorizes access with Globus Auth. It therefore requires that any authenticated calls be made with a bearer Authorization header:

Authorization: Bearer <token_string>

The token string is an Access Token provided via Globus Auth.

2.2. Scopes

Access tokens for Globus Search have one of the following scopes:

Name Full Scope String Definition

ingest

urn:globus:auth:scope:search.api.globus.org:ingest

The token authorizes the call to write data into Search

search

urn:globus:auth:scope:search.api.globus.org:search

The token authorizes the call to query data from Search

all

urn:globus:auth:scope:search.api.globus.org:all

The token authorizes the activities of both ingest and search

2.3. Permissions in Search

Globus Search evaluates and enforces permissions after successful authentication. In particular, a user may be

  • An admin of an index

  • A writer of an index

  • A member of the visible_to list of a document

These permissions are all evaluated against the linked identities and Globus Group memberships of a user.

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