API Reference / API Methods / Indexing / Delete objects
Required API Key: any key with the deleteObject ACL
Method signature
index.delete_objects(list objectIds)
index.delete_objects(list objectIds, dict requestOptions)

# delete a single object
index.delete_object(string objectID)
index.delete_object(string objectID, dict requestOptions)

About this method # A

Remove objects from an index using their objectID.

This method enables you to remove one or more objects from an index.

You can use two methods to delete objects:

  • This one (deleteObject), which uses objectID to identify objects
  • deleteBy, which uses filters to identify objects.

As with other batch operations, each record included in the batch counts as one operation. If you pass an objectID that doesn’t exist, it still counts as an operation because the engine doesn’t know if the record exists when attempting the operation. There is no limit to the number of objectIDs you can send to ‘deleteObject’.

Removing all objects in an index doesn’t delete the index. You have to delete it manually with the deleteIndex method.

This method also has a singular version.

Examples # A

Delete multiple objects using their objectIDs#

1
index.delete_objects(['myID1', 'myID2'])

Delete a single object#

1
index.delete_object('myID')

Delete multiple objects and send extra HTTP headers#

1
2
3
4
objectIDs = [
    # objectIDs
]
index.delete_objects(objectIDs, {'X-Forwarded-For': '94.228.178.246'})

Parameters # A

objectIDs #
type: list
Required

List of objectIDs to delete.

requestOptions #
type: key-value mapping
default: No request options
Optional

A mapping of requestOptions to send along with the query.

objectID #
type: integer|string
Required

The objectID of the object to delete.

Response # A

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format#

1
2
3
4
5
6
7
{
  "objectIDs": [
    "myObjectID1",
    "myObjectID2"
  ],
  "taskID": 678,
}
objectIDs #
list

List of the objectIDs of the deleted objects.

taskID #
integer

The taskID used with the waitTask method.

Did you find this page helpful?
Python v2