Collections
...
Collections API
Collections

Stop All Collections

3min
stop all collections stop all collections on your account that are currently in the queued or running state by making an http get request to the /collections/stopall endpoint the collections will be set back to the idle state for collections that are 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 example get get /collections/stopall http https //api bigboxapi com/collections/stopall?api key=demo$ curl "https //api bigboxapi com/collections/stopall?api key=demo"const axios = require('axios'); const params = { api key 'demo' } axios get('https //api bigboxapi com/collections/stopall', { params }) then(response => { const apiresponse = response data; console log('collections stopped '); }) catch(error => { console log(error); });import requests params = { 'api key' 'demo' } api result = requests get('https //api bigboxapi com/collections/stopall', params) api response = api result json() print "collections stopped "\<?php $querystring = http build query(\[ 'api key' => 'demo', ]); $ch = curl init(sprintf('%s?%s', 'https //api bigboxapi com/collections/stopall', $querystring)); curl setopt($ch, curlopt returntransfer, true); curl setopt($ch, curlopt followlocation, true); \# the following options are required if you're using an outdated openssl version \# more details https //www openssl org/blog/blog/2021/09/13/letsencryptrootcertexpire/ curl setopt($ch, curlopt ssl verifyhost, false); curl setopt($ch, curlopt ssl verifypeer, false); curl setopt($ch, curlopt timeout, 180); $json = curl exec($ch); curl close($ch); $api result = json decode($json, true); print r($api result); echo "collections stopped ", php eol; ?> bigbox api responds with a json object confirming that the collections have been stopped { "request info" { "success" true, "message" "23 collections stopped" }, "collections stopped" 23, "collections failed to stop" 0 } next steps get collections https //docs trajectdata com/bigboxapi/collections api/collections/get list collections https //docs trajectdata com/bigboxapi/collections api/collections/list