Delete by Subject

Submit a delete-by-subject task, which deletes a single subject.

You can then check the status of that Task using the Get Task API. Once your task is complete, the data will be removed from the search index and will no longer appear in query results.

Method	DELETE
URL	/v1/index/<index_id>/subject
Authentication required?	Yes
Required Roles	You must have `owner`, `admin`, or `writer` access
Request Body	None
Response Body	A DeleteSubjectResponse

Warning

Deleting a subject deletes all entries in that subject, including those those which are not visible to the current user.

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 (url-encoded) Subject string
bypass_visible_to	No	Defaults to False. Allowed for Index Admins only. When true, visible_to restrictions will be ignored for this lookup.

Parameter Name

Required?

Description

subject

Yes

The (url-encoded) Subject string

bypass_visible_to

Defaults to False.

Allowed for Index Admins only. When true, visible_to restrictions will be ignored for this lookup.

Response Schemas

DeleteSubjectResponse

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
}