Collections
...
Collections API
Requests

Clear Requests

4min

Clear Requests

All of the Requests in a collection can be cleared by making an HTTP DELETE request to the /collections/COLLECTION_ID/clear endpoint (where COLLECTION_ID is the id of the Collection).

Collection Status Collections can only be cleared from a Collection when it is not running. To check whether a Collection is currently running use the Get Collection endpoint.



Example

DELETE /collections/COLLECTION_ID/clear

In the example below we clear a Collection with id=123456 :

Curl
Node.js
Python
PHP


Backyard API responds with a JSON object confirming that the collection has been cleared:

JSON



Next Steps      Update Request      List Request

Updated 08 Aug 2024
Did this page help you?