Skip to content
StratumStratum Docs

List S3 buckets in a project.

GET
/v1/projects/{projectId}/objectstorage/buckets
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/projects/example/objectstorage/buckets \
  --header 'Authorization: Bearer <token>'

The project’s buckets with their reconciler-driven status (creating/available/deleting/error). Cedar-gated on s3:ListBuckets.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string
/^p-[a-z0-9-]+$/

Responses

Section titled “Responses”

200

Section titled “200”

Buckets.

Media typeapplication/json
object
items
Array<object>

A tenant S3 bucket + its reconciler-driven status.

object
bucketId
required
string
name
required
string
region
string
status
required

Reconciler-driven lifecycle phase. delete_blocked is terminal: a non-empty bucket whose delete returned BucketNotEmpty — empty it and re-issue the delete, or force-purge.

string
Allowed values: creating available deleting error delete_blocked
statusMessage
string
statusChangedAt

When the bucket entered its current status (bumped only on an actual status-value change, unlike a churning updatedAt) — lets an operator tell a just-created creating from a long-stuck one.

string format: date-time
tags
object
key
additional properties
string
projectId
required
string
endpoint

Client-facing S3 endpoint host for this bucket’s region — the value for aws --endpoint-url. Omitted when no public endpoint is configured (a dev install with no front-door domain).

string
pathStyleUrl

Path-style bucket URL (<scheme>://<endpoint>/<bucket>). Omitted when no endpoint.

string
virtualHostUrl

Virtual-host-style bucket URL (<scheme>://<bucket>.<endpoint>). Present only for a DNS-name endpoint (the front-door s3. shape).

string
createdAt
string format: date-time
isTruncated

True when the server had more rows than it returned. The response is a valid prefix of the result, not the whole of it.

Without this flag a client at the server’s row ceiling receives a full page and no nextPageToken, which means “this is the complete set” — so data it never saw would be indistinguishable from data that does not exist.

It does not imply a cursor exists. These queries do not all sort on a total order, so a resumable token cannot be minted for them yet. The remedy is to narrow the request (a filter, or a tighter scope), not to page.

boolean

Example 

{
  "items": [
    {
      "status": "creating"
    }
  ]
}

403

Section titled “403”

Authenticated but not authorized.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}