Test a storage bucket

POST/settings/storage/{id}/check/

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

Proves the panel can list, write and delete in the bucket, and keeps the result on it. 400 with ok: false when it cannot. Panel operators only.

Path parameters

idstring (uuid)required
A UUID string identifying this Storage Connection.

Body

prefixstring
A folder of the bucket to test in.

Response

200 OK

okbooleanrequired
detailstringrequired
What the test found, in plain words.

Errors

400
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.
404 Nothing with this id, or nothing the account can see.
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/settings/storage/1/check/' \
  -H "Authorization: Bearer $MINIMUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "prefix": "string"
}'

Python

import os
import requests

response = requests.post(
    "https://panel.example.com/settings/storage/1/check/",
    headers={"Authorization": f"Bearer {os.environ['MINIMUS_API_KEY']}"},
    json={
        "prefix": "string"
    },
)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://panel.example.com/settings/storage/1/check/', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.MINIMUS_API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "prefix": "string"
  }),
});
if (!response.ok) throw new Error(`${response.status}`);
console.log(await response.json());

Response 200

{
  "ok": true,
  "detail": "string"
}

Test a storage bucket

Path parameters#

Body#

Response#

200 OK

Errors#

Path parameters

Body

Response

Errors