Search API Menu
  • Globus Search
  • Overview
  • API Usage & Basics
  • Ingest
  • Query
  • Types, Type Detection, and Schemas
  • Error Handling
  • API Reference
    • Batch Delete by Subject
    • Create or Update Entry
    • Delete by Query
    • Delete by Subject
    • Delete Entry
    • Get Entry
    • GET Query
    • Get Subject
    • Get Task
    • Index Create
    • Index Delete
    • Index List
    • Index Reopen
    • Ingest
    • POST Query
    • Role Create
    • Role Delete
    • Role List
    • Scroll Query
    • Show Index
    • Task List
  • Guides
    • Geospatial Search
    • Role Based Filtering
    • Searchable Files
  • Globus Search Limits
  • API Change History
Skip to main content
Globus Docs
  • APIs
    Auth Compute Flows Globus Connect Server Groups Search Transfer Python SDK Helper Pages
  • How To
  • Guides
    Globus Connect Server High Assurance Collections for Protected Data 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 Delete

This API marks an index for deletion — the action is not immediate. After this API method has been called, the index will be marked with status="delete-pending", and will be cleaned up according to the applicable policy.

delete-pending indices cannot have active tasks in progress. Tasks which are already in progress will terminate, and any pending tasks will be transitioned to the CANCELLED state.

Indices with a trial status of is_trial=true will be deleted a few minutes after being marked for deletion. Indices with a trial status of is_trial=false are kept for 30 days prior to deletion, and are eligible for use with the reopen API, once they are marked delete-pending.

Method

DELETE

URL

/v1/index/<index_id>

Authentication required?

yes

Required Roles

owner on the index

Response Body

an IndexDeleteResponse document

Authentication & Authorization

Tokens for this call must have this scope:

urn:globus:scopes:search.api.globus.org:all
Example: Deleting an index

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

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

Response Schemas

IndexDeleteResponse

Field Name Type Description

index_id

UUID

The ID of the Index

acknowledged

Boolean

Always true

  • Globus Search
  • Overview
  • API Usage & Basics
  • Ingest
  • Query
  • Types, Type Detection, and Schemas
  • Error Handling
  • API Reference
    • Batch Delete by Subject
    • Create or Update Entry
    • Delete by Query
    • Delete by Subject
    • Delete Entry
    • Get Entry
    • GET Query
    • Get Subject
    • Get Task
    • Index Create
    • Index Delete
    • Index List
    • Index Reopen
    • Ingest
    • POST Query
    • Role Create
    • Role Delete
    • Role List
    • Scroll Query
    • Show Index
    • Task List
  • Guides
    • Geospatial Search
    • Role Based Filtering
    • Searchable Files
  • Globus Search Limits
  • API Change History
© 2010- The University of Chicago Legal Privacy Accessibility