Count background tasks

GET/jobs/summary/

read Read: looks, changes nothing. Scopes

How many tasks are in each state, how many are active per kind, and how many failed in the last 24 hours, among the tasks you may see.

Response

200 OK

activeintegerrequired
Queued and running tasks.
countsobjectrequired
Tasks per state.
active_by_kindobjectrequired
Active tasks per kind.
failed_24hintegerrequired

Errors

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 'https://panel.example.com/jobs/summary/' \
  -H "Authorization: Bearer $MINIMUS_API_KEY"

Python

import os
import requests

response = requests.get(
    "https://panel.example.com/jobs/summary/",
    headers={"Authorization": f"Bearer {os.environ['MINIMUS_API_KEY']}"},
)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://panel.example.com/jobs/summary/', {
  method: 'GET',
  headers: { Authorization: `Bearer ${process.env.MINIMUS_API_KEY}` },
});
if (!response.ok) throw new Error(`${response.status}`);
console.log(await response.json());

Response 200

{
  "active": 1,
  "counts": {
    "key": 1
  },
  "active_by_kind": {
    "key": 1
  },
  "failed_24h": 1
}

Count background tasks

Response#

200 OK

Errors#

Response

Errors