Skip to main content
GET
List objects
Requires the IAM action storage:ListBucket. See STORAGE permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Path Parameters

bucket
string
required
Example:

"my-app-assets"

Query Parameters

prefix
string
Example:

"images/"

delimiter
string
Example:

"/"

marker
string
Example:

"images/logo.png"

max_keys
integer
default:1000
Required range: 1 <= x <= 1000
Example:

1000

Response

Object listing.

objects
object[]
common_prefixes
string[]
is_truncated
boolean
Example:

false

meta
object