Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1338139174.7 KB
projects

Bulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will not be deleted. The bulk delete occurs in the background and its progress can be monitored and managed via the Operation resource that is created. For more details on bulk delete behavior, refer to: https://cloud.google.com/firestore/docs/manage-data/bulk-delete

post/v1/{+name}:bulkDeleteDocuments

Path parameters

namestring required

Required. Database to operate. Should be of the form: projects/{project_id}/databases/{database_id}.

Request body

collectionIdsstring[]

Optional. IDs of the collection groups to delete. Unspecified means all collection groups. Each collection group in this list must be unique.

namespaceIdsstring[]

Optional. Namespaces to delete. An empty list means all namespaces. This is the recommended usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to delete from them. Each namespace in this list must be unique.

Response

Successful response