Index Create

This API allows creation of an index.

Index creation is limited, effectively to one index per user. When you create an index, it is marked as a trial and has a low maximum size, and you are automatically added as an owner of the index.

Users may only own one trial index.

To convert a trial index to non-trial, associate it with your Globus Subscription, and increase the size limit, contact us at support@globus.org .

Note

Globus does not guarantee the durability of trial indices, and they may be cleaned up after a period of time. If you intend to use an index in the long-term, even with a small data size, you should convert to a non-trial index.

Method	POST
URL	/v1/index
Authentication required?	yes
Request Body	an IndexCreate document
Response Body	a GSearchIndex document

Authentication & Authorization

Tokens for this call must have this scope:

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

Example curl

To create Awesome Index of Awesomeness:

curl \
  -XPOST \
  -H "Authorization: Bearer $SEARCH_TOKEN" \
  'https://search.api.globus.org/v1/index' \
  -d '
{
  "display_name": "Awesome Index of Awesomeness",
  "description": "An index so awesome that it simply cannot be described"
}
'

where $SEARCH_TOKEN is an access token.

Request Schemas

IndexCreate

An index creation document is a partial GSearchIndex document containing only the fields which are needed to create the index.

Field Name	Type	Description
display_name	String	A common name for the index suitable for display in user interfaces
description	String	A description of the index

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