Search API Menu
  • Globus Search
  • Overview
  • API Usage & Basics
  • Ingest
  • Query
  • Types, Type Detection, and Schemas
  • Error Handling
  • API Reference
    • Create or Update Entry
    • Delete by Query
    • Delete by Subject
    • Delete Entry
    • Get Entry
    • GET Query
    • Get Subject
    • Get Task
    • Index Create (BETA)
    • Index Delete (BETA)
    • Index List
    • Index Reopen (BETA)
    • 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 Flows 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

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: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.

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
}
  • Globus Search
  • Overview
  • API Usage & Basics
  • Ingest
  • Query
  • Types, Type Detection, and Schemas
  • Error Handling
  • API Reference
    • Create or Update Entry
    • Delete by Query
    • Delete by Subject
    • Delete Entry
    • Get Entry
    • GET Query
    • Get Subject
    • Get Task
    • Index Create (BETA)
    • Index Delete (BETA)
    • Index List
    • Index Reopen (BETA)
    • 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