Delete Collection

3min

Delete Collection
Collections can be deleted by making an HTTP DELETE request to the /collections/COLLECTION_ID endpoint (where COLLECTION_ID is the id of the Collection you wish to delete).
A Collection can only be deleted when it is not running. To check whether a Collection is currently running use the Get Collection endpoint.
Example
﻿DELETE  /collections/COLLECTION_ID
In the example below we delete a Collections with id=123456 :
Curl
Node.js
Python
PHP
$ curl -X DELETE "https://api.backyardapi.com/collections/123456?api_key=demo"
$ curl -X DELETE "https://api.backyardapi.com/collections/123456?api_key=demo"
﻿
Backyard API responds with a JSON object confirming that the Collection has been deleted, or detailing the error if it has not been possible to delete the Collection:
JSON
{
  "request_info": {
    "success": true,
    "message": "collection deleted"
  }
}
{
  "request_info": {
    "success": true,
    "message": "collection deleted"
  }
}
﻿
﻿
Next Steps
     Get Collections
     List Collections﻿

Updated 08 Aug 2024

Did this page help you?

Stop All Collections

Get Collection