Index Update

This API allows modification of index metadata.

Note

At present, only informational metadata (name and description) is modifiable with this API. For other modifications, please contact support@globus.org.

Method	PATCH
URL	/v1/index/<index_id>
Authentication required?	yes
Request Body	an IndexUpdate 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

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

curl \
  -XPATCH \
  -H "Authorization: Bearer $SEARCH_TOKEN" \
  'https://search.api.globus.org/v1/index/4de0e89e-a395-11e7-bc54-8c705ad34f60' \
  -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

IndexUpdate

An index update document is a partial GSearchIndex document containing any fields which support modification. Omitted fields will remain unchanged.

Field Name	Type	Description
display_name	String	Optional. A new common name for the index suitable for display in user interfaces
description	String	Optional. A new 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`
available	Boolean	The `available` field indicates whether or not an index is available to serve queries and process tasks. It is `true` for active indices, but `false` when an index is being deleted or Globus Search is unable to access the index data.
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
content_last_modified_date	String	A timestamp in UTC, set when the index is created and updated when the content is modified via ingest, delete entry, delete subject, or delete by query operations. This field will be `null` if no write operations have occurred on the index since this field was added.

Example GSearchIndex

{
  "@datatype": "GSearchIndex",
  "@version": "2017-09-01",
  "available": true,
  "creation_date": "2021-04-05 15:05:18",
  "content_last_modified_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"
}