MOmongodb

Delete Documents

Changed on

Delete multiple documents that match a query.

post/action/deleteMany

Request

  • Base URL
    https://data.mongodb-api.com/app/your-app-id/endpoint/data/v1
  • URL
    https://data.mongodb-api.com/app/your-app-id/endpoint/data/v1/action/deleteMany
  • Auth
    • API key in header Authorization
    • or API key in header email and API key in header password
    • or API key in header apiKey
    • or API key in header jwtTokenString

Request body

dataSourcestring required

The name of a linked MongoDB Atlas data source. This is commonly "mongodb-atlas" though it may be different in your App if you chose a different name when you created the data source.

databasestring required

The name of a database in the specified data source.

collectionstring required

The name of a collection in the specified database.

filterobject

A MongoDB query filter that matches documents. For a list of all query operators that the Data API supports, see Query Operators.

Response

Deleted

deletedCountnumber required

The number of documents that were deleted.

Example response

{
  "deletedCount": 12
}

Changes

  • 5088bc79b2f0Revision changes
    • breaking

      the / response's property type changed from number object to no type for status (media type: application/json)

    • breaking

      the / response's property type changed from number object to no type for status (media type: application/ejson)