Index Delete (BETA)
This API is in beta. We may make backwards-incompatible changes while it is in this state. If you write code which uses it, just be aware that the API may change in breaking ways up until it moves out of beta.
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 |
/beta/index/<index_id> |
Authentication required? |
yes |
Required Roles |
|
Response Body |
an IndexDeleteResponse document |
Authentication & Authorization
Tokens for this call must have this scope:
urn:globus:scopes:search.api.globus.org:all
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'