Preview deleting many streams

POST/streams/bulk-delete/plan/

manage Delete and money: deletes, credits, servers or panel settings. Scopes

What deleting the selection would remove, touching nothing: streams, their sessions, the sources only they use (sources_orphaned) and the streams playing now. A selection is the streams ticked (ids) or every stream the list filters select (all_matching: true with filters, less exclude).

Body

selectionobjectrequired
The streams a bulk action applies to: the ones ticked (ids), or every stream the list filters select (all_matching: true with filters, which take the list's query parameters), less exclude.
- idsstring (uuid)[]
- all_matchingboolean
  Default: false
- filtersobject
- excludestring (uuid)[]

Response

200 OK

streamsintegerrequired
sessionsintegerrequired
sources_orphanedintegerrequired
Sources deleted with them.
sources_keptintegerrequired
Sources other streams still use.
playingintegerrequired
Streams stopped first.
samplestring[]required
Up to 10 names.

Errors

400 Something sent is not valid. Each field that is wrong is named with what is wrong.
401 No credential, or one that is wrong, expired or revoked.
403 The account, or the key's or app's scopes, may not do this.
429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means

cURL

curl -X POST 'https://panel.example.com/streams/bulk-delete/plan/' \
  -H "Authorization: Bearer $MINIMUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "selection": {
    "ids": [
      "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b"
    ],
    "all_matching": false,
    "filters": {
      "key": "string"
    }
  }
}'

Python

import os
import requests

response = requests.post(
    "https://panel.example.com/streams/bulk-delete/plan/",
    headers={"Authorization": f"Bearer {os.environ['MINIMUS_API_KEY']}"},
    json={
        "selection": {
            "ids": [
                "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b"
            ],
            "all_matching": False,
            "filters": {
                "key": "string"
            }
        }
    },
)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://panel.example.com/streams/bulk-delete/plan/', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.MINIMUS_API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "selection": {
      "ids": [
        "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b"
      ],
      "all_matching": false,
      "filters": {
        "key": "string"
      }
    }
  }),
});
if (!response.ok) throw new Error(`${response.status}`);
console.log(await response.json());

Response 200

{
  "streams": 1,
  "sessions": 1,
  "sources_orphaned": 1,
  "sources_kept": 1,
  "playing": 1,
  "sample": [
    "string"
  ]
}

Preview deleting many streams

Body#

Response#

200 OK

Errors#

Body

Response

Errors