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  /collections/stopall
HTTP
Curl
Node.js
Python
PHP
https://api.backyardapi.com/collections/stopall?api_key=demo
https://api.backyardapi.com/collections/stopall?api_key=demo
﻿
Backyard API responds with a JSON object confirming that the Collections have been stopped.
JSON
{
  "request_info": {
    "success": true,
    "message": "23 Collections stopped"
  },
  "collections_stopped": 23,
  "collections_failed_to_stop": 0
}
{
  "request_info": {
    "success": true,
    "message": "23 Collections stopped"
  },
  "collections_stopped": 23,
  "collections_failed_to_stop": 0
}
﻿
﻿
Next Steps
     Get Collections
     List Collections﻿

Updated 08 Aug 2024

Did this page help you?

Stop Collection

Delete Collection