List background task kinds and states

GET/jobs/options/

read Read: looks, changes nothing. Scopes

The kinds and states to filter the list by, with their labels.

Response

200 OK

kindsobject[]required
- valuestringrequired
- labelstringrequired
statesobject[]required
- valuestringrequired
- labelstringrequired
active_statesstring[]required

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/options/' \
  -H "Authorization: Bearer $MINIMUS_API_KEY"

Python

import os
import requests

response = requests.get(
    "https://panel.example.com/jobs/options/",
    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/options/', {
  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

{
  "kinds": [
    {
      "value": "string",
      "label": "string"
    }
  ],
  "states": [
    {
      "value": "string",
      "label": "string"
    }
  ],
  "active_states": [
    "string"
  ]
}

List background task kinds and states

Response#

200 OK

Errors#

Response

Errors