Entry Delete

Delete a single entry in a Search Index. This API submits an asynchronous task.

This returns a task_id which can be used to monitor thestatus of the task. You must have permissions to write to the index.

Method

DELETE

URL

/v1/index/<index_id>/entry

Authentication required?

Yes

Required Roles

You must have owner, admin, or writer access

Response Body

A DeleteEntryResponse

These scopes are valid for authenticated calls:

Authentication & Authorization

Tokens for this call must have one of these scopes.

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

Parameters

Parameter Name Required? Description

subject

Yes

The subject containing the entry to be operated upon. The value takes the same form as the subject property of the GMetaEntry structure. The value should be url-encoded.

entry_id

No

The entry_id of the entry to be operated upon, if it is not null

Examples

  • in the index 4de0e89e-a395-11e7-bc54-8c705ad34f60

  • with a subject of https://example.com/foo/bar

  • with a null entry_id

curl -XDELETE 'https://search.api.globus.org/v1/index/4de0e89e-a395-11e7-bc54-8c705ad34f60/entry?subject=https%3A%2F%2Fexample.com%2Ffoo%2Fbar'

Response Schemas

DeleteEntryResponse

Field Name Type Description

task_id

UUID

the ID of the submitted task

removed

Boolean

This is a legacy field kept for compatibility. It will always be true.
Example
{
  "task_id": "0c21ee5d-e847-415f-831f-b325af794716",
  "removed": true
}