Delete a collection by ID. | Scout API & SDK Reference

Delete a collection. By default, enqueues deletion and returns immediately. Pass await_completion=true to block until deletion is fully complete.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

collection_idstringRequired

await_completionbooleanOptionalDefaults to false

Whether to wait for collection deletion to complete before responding

Successful Response

detailstring

422

Unprocessable Entity Error

$	curl -X DELETE https://api.scoutos.com/v2/collections/collection_id \
>	-H "Authorization: Bearer <token>"

1	{
2	"detail": "Collection deletion has been enqueued and will complete shortly."
3	}