object-storage, os
Commands that act on one endpoint, including the policy and access key commands, take its ID either as a positional argument or with --id. If you omit it, the CLI opens an interactive picker, so always pass it in scripts.
Subcommands
- list — List object storage endpoints
- classes — List object storage endpoint classes
- get — Get object storage endpoint details
- create — Create a new object storage endpoint
- delete — Delete an object storage endpoint
- list-policies — List identity policies for an endpoint
- get-policy-document — Show the JSON policy document for an identity policy
- create-policy — Create a new identity policy on an endpoint
- update-policy — Update an existing identity policy
- delete-policy — Delete an identity policy from an endpoint
- list-access-keys — List access keys for an endpoint
- create-access-key — Create a new access key for an endpoint
- delete-access-key — Delete an access key from an endpoint
list
List object storage endpoints, optionally filtered by organization, project, or region.Flags
| Flag | Description |
|---|---|
| Organization ID | |
| Project ID | |
| Region ID | |
Emit the full JSON payload (mutually exclusive with -q) | |
jq filter for value extraction (see Query output with -q) |
Example
classes
List the object storage endpoint classes you can create endpoints in. A class sets the region an endpoint lives in and the endpoint types it supports. Pass its ID asspec.objectStorageEndpointClassId when you create an endpoint. The table shows each class’s ID, name, region, and endpoint types.
Flags
| Flag | Description |
|---|---|
| Organization ID | |
| Region ID (defaults to all regions) | |
Emit the full JSON payload (mutually exclusive with -q) | |
jq filter for value extraction (see Query output with -q) |
Examples
get
Get details for a specific object storage endpoint.Flags
| Flag | Description |
|---|---|
| Object storage endpoint ID | |
| Organization ID | |
Emit the full JSON payload (mutually exclusive with -q) | |
jq filter for value extraction (see Query output with -q) |
create
Create a new object storage endpoint. Accepts input from a JSON file or stdin.Flags
| Flag | Description |
|---|---|
| Path to a JSON file | |
| Read JSON from standard input | |
| Preview actions and payload without persisting | |
| Automatically confirm creation | |
Emit the full JSON payload (mutually exclusive with -q) | |
jq filter for value extraction (see Query output with -q) |
Examples
delete
Delete an existing object storage endpoint.Flags
Example
list-policies
List identity policies for an object storage endpoint.Flags
| Flag | Description |
|---|---|
| Object storage endpoint ID | |
| Organization ID | |
Emit the full JSON payload (mutually exclusive with -q) | |
jq filter for value extraction (see Query output with -q) |
get-policy-document
Show the JSON policy document for an identity policy on an object storage endpoint.Flags
| Flag | Description |
|---|---|
| Object storage endpoint ID | |
| Identity policy name | |
| Organization ID | |
Emit the full JSON payload (mutually exclusive with -q) | |
jq filter for value extraction (see Query output with -q) |
create-policy
Create a new identity policy on an object storage endpoint. The policy document is read from a JSON file or stdin.Flags
| Flag | Description |
|---|---|
| Object storage endpoint ID | |
| Identity policy name | |
| Organization ID | |
| Path to a JSON policy document file | |
| Read JSON from standard input | |
| Preview actions and payload without persisting | |
| Automatically confirm creation | |
Emit the full JSON payload (mutually exclusive with -q) | |
jq filter for value extraction (see Query output with -q) |
Examples
update-policy
Update an existing identity policy on an object storage endpoint. The policy document is read from a JSON file or stdin.Flags
| Flag | Description |
|---|---|
| Object storage endpoint ID | |
| Identity policy name | |
| Organization ID | |
| Path to a JSON policy document file | |
| Read JSON from standard input | |
| Preview actions and payload without persisting | |
| Automatically confirm update | |
Emit the full JSON payload (mutually exclusive with -q) | |
jq filter for value extraction (see Query output with -q) |
Examples
delete-policy
Delete an identity policy from an object storage endpoint.Flags
Example
list-access-keys
List access keys for an object storage endpoint.Flags
| Flag | Description |
|---|---|
| Object storage endpoint ID | |
| Organization ID | |
Emit the full JSON payload (mutually exclusive with -q) | |
jq filter for value extraction (see Query output with -q) |
create-access-key
Create a new access key for an object storage endpoint, optionally associated with an identity policy.Flags
| Flag | Description |
|---|---|
| Object storage endpoint ID | |
| Access key name | |
| Identity policy name to associate with the access key | |
| Organization ID | |
| Preview actions and payload without persisting | |
| Automatically confirm creation | |
Emit the full JSON payload (mutually exclusive with -q) | |
jq filter for value extraction (see Query output with -q) |
Example
delete-access-key
Delete an access key from an object storage endpoint.Flags
Example
Related
S3 API (CLI)
Manage buckets and objects inside an endpoint.
Object Storage (Console)
Create and manage object storage via the Console UI.