Search API Menu

Globus SearchOverviewAPI Usage & BasicsIngestQueryTypes, Type Detection, and SchemasError Handling
API Reference
Create or Update EntryDelete by QueryDelete by SubjectDelete EntryGet EntryGET QueryGet SubjectGet TaskIndex Create (BETA)Index ListIngestPOST QueryRole CreateRole DeleteRole ListScroll QueryShow IndexTask List
Guides
Role Based Filtering
Globus Search LimitsAPI Change History
Skip to main content
Globus Docs
  • APIs
    • Auth
    • Transfer
    • Groups
    • Search
    • Python SDK
    • Helper Pages
  • How To
  • Guides
    • Globus Connect Server Installation Guides
    • High Assurance Collections for Protected Data
    • Management Console Guide
    • 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

Index List

This API provides a list document of indices on which the caller has admin or writer permissions.

At most 100 indices will be returned in a listing.

Method

GET

URL

/v1/index_list

Authentication required?

yes

Response Body

an IndexList document

Authentication & Authorization

Tokens for this call must have this scope:

urn:globus:scopes:search.api.globus.org:all
Example curl
curl \
  -XGET \
  -H "Authorization: Bearer $SEARCH_TOKEN" \
  'https://search.api.globus.org/v1/index_list'

where $SEARCH_TOKEN is an access token.

Response Schemas

IndexList

An index list is a container of IndexWithPermissions documents. It has the following fields:

Field Name Type Description

index_list

Array of Objects

An array of IndexWithPermissions documents

Example IndexWithPermissions
{
  "index_list": [
    {
      "creation_date": "2017-09-05 19:02:18",
      "description": "",
      "display_name": "globus_search",
      "id": "e56fdc95-0c55-4533-ba51-c1e8619ece7b",
      "permissions": [
        "admin"
      ],
      "max_size_in_mb": 5000,
      "num_entries": 1,
      "num_subjects": 1,
      "size_in_mb": 0
    }
  ]
}

IndexWithPermissions

The following document type, an IndexWithPermissions document, describes various attributes of an index and includes the permissions field. It is otherwise the same as an index document (as fetched from Index Show).

Field Name Type Description

permissions

Array of Strings

The roles of the current user on this index. Values in this array are one of {"owner", "admin", "writer"}

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 UTC timestamp, indicating when the index was created

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 IndexWithPermissions
{
  "creation_date": "2017-09-05 19:02:18",
  "description": "",
  "display_name": "globus_search",
  "id": "e56fdc95-0c55-4533-ba51-c1e8619ece7b",
  "permissions": [
    "admin"
  ],
  "max_size_in_mb": 5000,
  "num_entries": 1,
  "num_subjects": 1,
  "size_in_mb": 0
}
Globus SearchOverviewAPI Usage & BasicsIngestQueryTypes, Type Detection, and SchemasError Handling
API Reference
Create or Update EntryDelete by QueryDelete by SubjectDelete EntryGet EntryGET QueryGet SubjectGet TaskIndex Create (BETA)Index ListIngestPOST QueryRole CreateRole DeleteRole ListScroll QueryShow IndexTask List
Guides
Role Based Filtering
Globus Search LimitsAPI Change History
© 2010- The University of Chicago Legal Accessibility