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
  4. API Reference

Show Index

Method

GET

URL

/v1/index/<index_id>

Authentication required?

no

Response Body

a GSearchIndex document

Example: Looking up an index

Looking up an index with an id of 4de0e89e-a395-11e7-bc54-8c705ad34f60:

curl -XGET 'https://search.api.globus.org/v1/index/4de0e89e-a395-11e7-bc54-8c705ad34f60'

Response Schemas

GSearchIndex

The following document type, a GSearchIndex document, describes various attributes of an index.

Field Name Type Description

display_name

String

A common name for the index suitable for display in user interfaces

id

String

A UUID uniquely identifying this index

description

String

A description of the index

creation_date

String

A timestamp in UTC, indicating when the index was created

is_trial

Boolean

Whether or not the index has "trial" status, meaning that there is no data durability guarantee and the index may be automatically deleted at any time starting 30 days after creation_date

subscription_id

String

The ID of the subscription to which this index is attached, if there is one (null otherwise)

max_size_in_mb

Integer

The maximum size the index will be permitted to grow to in units of Megabytes (1MB = 1,000,000 bytes)

size_in_mb

Integer

The current size of the index rounded down to the closest Megabyte value

num_subjects

Integer

The number of unique subjects stored in the index

num_entries

Integer

The number of GMetaEntries stored in the index

Example GSearchIndex
{
  "@datatype": "GSearchIndex",
  "@version": "2017-09-01",
  "creation_date": "2021-04-05 15:05:18",
  "display_name": "Awesome Index of Awesomeness",
  "description": "An index so awesome that it simply cannot be described",
  "id": "e56fdc95-0c55-4533-ba51-c1e8619ece7b",
  "is_trial": true,
  "subscription_id": null,
  "max_size_in_mb": 1,
  "num_entries": 0,
  "num_subjects": 0,
  "size_in_mb": 0,
  "status": "open"
}
  • 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