Collections can be stopped when they are in the queued or running state by making an HTTP GET request to the /collections/COLLECTION_ID/stop endpoint (where COLLECTION_ID is the id of the Collection).

When stopping a Collection that is currently queued you will be refunded for the credits allocated for that Collection run. If the Collection has already started running (i.e. it is in the state running ) then a credit refund will not be issued, but the Collection will still be stopped.

GET /collections/COLLECTION_ID/stop

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

BigBox API responds with a JSON object confirming that the Collection has been stopped, or detailing the error if it has not been possible to stop the Collection (i.e. if the Collection is not curently queued or running ).

Next Steps      Get Collections      List Collections      Stop All Collections