Aliases: object-storage, osCommands that act on one endpoint, including the policy and access key commands, take its ID or name either as a positional argument or with --id. If you omit it, the CLI opens an interactive picker, so always pass it in scripts.
In v7.0.0, the policy and access key commands moved under policy and access-key. For example, create-access-key is now access-key create and get-policy-document is now policy get-document. The old names still work, with the same flags, but are hidden from help.
Subcommands
list — List object storage endpointsclasses — List object storage endpoint classesget — Get object storage endpoint detailscreate — Create a new object storage endpointdelete — Delete an object storage endpoint
Identity policies (aliases: policy, policies)Access keys (aliases: access-key, access-keys)list List object storage endpoints, optionally filtered by organization, project, or region.
Flags Flag Description Organization ID or name Project ID or name Region ID or name Show at most N results (client-side; every result is still fetched). Cuts before -q. 0 for all 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 as spec.objectStorageEndpointClassId when you create an endpoint. The table shows each class’s ID, name, region, and endpoint types.
Flags Flag Description Organization ID or name Region ID or name (defaults to all regions) Show at most N results (client-side; every result is still fetched). Cuts before -q. 0 for all 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 or name. Can also be passed as a positional argument Organization ID or name 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. Provisioning is asynchronous: without --wait, the command returns as soon as the request is accepted.
Flags Flag Description Path to a JSON file Read JSON from standard input Preview actions and payload without persisting Automatically confirm creation Block until provisioning finishes. Without it, the command returns as soon as the request is accepted How long polls before giving up. The operation keeps running server-side (default 30m0s) 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. Teardown is asynchronous: without --wait, the command returns as soon as the request is accepted, and the endpoint disappears some time later.
Aliases: delete, rm, removeFlags Examples policy list List identity policies for an object storage endpoint.
Flags Flag Description Object storage endpoint ID or name. Can also be passed as a positional argument Organization ID or name Show at most N results (client-side; every result is still fetched). Cuts before -q. 0 for all Emit the full JSON payload (mutually exclusive with -q) jq filter for value extraction (see Query output with -q )
policy get-document Show the JSON policy document for an identity policy on an object storage endpoint.
Flags Flag Description Object storage endpoint ID or name. Can also be passed as a positional argument Identity policy name Organization ID or name Emit the full JSON payload (mutually exclusive with -q) jq filter for value extraction (see Query output with -q )
policy create 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 or name. Can also be passed as a positional argument Identity policy name Organization ID or name 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 policy update 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 or name. Can also be passed as a positional argument Identity policy name Organization ID or name 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 policy delete Delete an identity policy from an object storage endpoint.
Aliases: delete, rm, removeFlags Example access-key list List access keys for an object storage endpoint.
Flags Flag Description Object storage endpoint ID or name. Can also be passed as a positional argument Organization ID or name Show at most N results (client-side; every result is still fetched). Cuts before -q. 0 for all Emit the full JSON payload (mutually exclusive with -q) jq filter for value extraction (see Query output with -q )
access-key create Create a new access key for an object storage endpoint, optionally associated with an identity policy.
Flags Flag Description Object storage endpoint ID or name. Can also be passed as a positional argument Access key name Identity policy name to associate with the access key Organization ID or name 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 access-key delete Delete an access key from an object storage endpoint.
Aliases: delete, rm, removeFlags Example
S3 API (CLI) Manage buckets and objects inside an endpoint.
Object Storage (Console) Create and manage object storage via the Console UI.
