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 |
Request Body |
None |
Response Body |
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:scopes:search.api.globus.org:all urn:globus:scopes:search.api.globus.org:ingest
Parameters
| Parameter Name | Required? | Description |
|---|---|---|
subject |
Yes |
The (url-encoded) Subject string |
result_format_version |
No |
One of {"2019-08-27", "2017-09-01"}. Defaults to 2019-08-27. When given as 2017-09-01, results will be returned in the legacy format. |
bypass_visible_to |
No |
Defaults to False. Allowed for Index Admins only. When true, visible_to restrictions will be ignored for this lookup. |