Index List

This API provides a list document of indices on which the caller has permissions. Each result in the list will be annotated with a list of the caller’s 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:auth:scope:search.api.globus.org:all

Parameters

Parameter Name Required? Description

Parameter Name	Required?	Description
filter_roles	No	A comma-delimited list of roles to use to filter the listing. The values in the list must be valid role names, `owner`, `admin`, or `writer`. By default, the listing covers all roles, equivalent to `filter_roles=owner,admin,writer`.

filter_roles

A comma-delimited list of roles to use to filter the listing. The values in the list must be valid role names, owner, admin, or writer.

By default, the listing covers all roles, equivalent to filter_roles=owner,admin,writer.

Example curl

curl \
  -XGET \
  -H "Authorization: Bearer $SEARCH_TOKEN" \
  'https://search.api.globus.org/v1/index_list?filter_roles=owner'

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,
      "status": "open"
    }
  ]
}

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 GSearchIndex document.

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 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 IndexWithPermissions

{
  "creation_date": "2017-09-05 19:02:18",
  "description": "",
  "display_name": "globus_search",
  "id": "e56fdc95-0c55-4533-ba51-c1e8619ece7b",
  "is_trial": true,
  "subscription_id": null,
  "permissions": [
    "admin"
  ],
  "max_size_in_mb": 5000,
  "num_entries": 1,
  "num_subjects": 1,
  "size_in_mb": 0,
  "status": "open"
}

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"
}