Settings

Browse a storage bucket

GET/settings/storage/{id}/browse/

read Read: looks, changes nothing. Scopes

One folder of the bucket: its folders and files, up to 1000 at a time. Panel operators only.

Path parameters

  • idstring (uuid)required

    A UUID string identifying this Storage Connection.

Query parameters

  • pathstring

    The folder, e.g. movies/2024/.

  • tokenstring

    next_token of the previous answer, for the next entries.

Response

200 OK

  • pathstringrequired

    The folder listed.

  • parentstringrequiredcan be null

    Its parent folder; null at the top.

  • entriesobject[]required
    • pathstringrequired
    • namestringrequired
    • is_dirbooleanrequired
    • size_bytesintegerrequired
    • modifiedstringrequiredcan be null
  • truncatedbooleanrequired

    More entries follow: ask again with token.

  • next_tokenstringrequiredcan be null

Errors

  • 400 The bucket refused; detail says why.
  • 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.
  • 502 The bucket could not be reached.

What each error means