Description

The Ingest Metadata API provides a method for getting more information about an index. This includes summary information including naming and description as well as basic status information in terms of the size of the index.

URL

/v1/index/<index_name>

Method

GET

HTTP Headers

None

Query Parameters

None

Request Body

None

Response Body

a GSearchIndex document

Error Responses

HTTP Code 404: The named index does not exist.

The body will contain a GError document

cURL Example 1

Looking up the index

  • with a name of myindex

curl 'https://search.api.globus.org/v1/index/myindex'

cURL Example 2

Looking up the index

  • with an id of 4de0e89e-a395-11e7-bc54-8c705ad34f60

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

© 2010- The University of Chicago Legal