bucket list

read onlyrepeatable

The team's buckets, with the name S3 clients use for each and whether it is public.

Names are unique in a team, so every command here takes a bucket's name or its id. A bucket whose create timed out is listed here if the create finished.

Usage

outplane bucket list

Output

Field	Type	Description
`id`	`string`
`name`	`string`	What the platform calls it, unique in the team.
`bucketName`	`string`	The name S3 clients use. It carries a suffix, so it differs from name.
`public`	`bool`	The setting last accepted: whether anyone with a file's link can read it. A change takes minutes to reach every request. Listing stays off either way.
`endpoint`	`string`	The S3 endpoint. Clients need virtual-hosted addressing; path-style requests fail.
`region`	`string`	The region clients sign with, always auto.
`url`	`string`	The bucket's own address. It serves a file without a signature only when the bucket is public, and after a change to private it can keep doing so for some minutes.
`createdAt`	`string \| null`	RFC 3339, UTC.

Examples

Every bucket in the team

outplane bucket list

Read the names clients use, in a script

outplane bucket list --json --fields name,bucketName,public

{
  "items": [
    {
      "bucketName": "uploads-<SUFFIX>",
      "name": "uploads",
      "public": false
    }
  ],
  "total": 1,
  "truncated": false
}

The same list as a table, in a pipe

outplane bucket list -o text

What to Know

An empty list is not an error. A team starts with no buckets.
bucketName, not name, is what goes in an S3 client.
A bucket whose create timed out appears here if the create finished.

Errors

Beyond 0 for success, this command exits with:

Exit	Kind	Meaning
`2`	`usage`	Invalid arguments, unknown flag, or client-side validation failure.
`3`	`auth`	Not authenticated, token revoked or expired, or forbidden for this team.
`8`	`upstream`	The Out Plane API returned a server error.