Skip to main content
Aliases: object-storage, os

Subcommands


list

List object storage endpoints, optionally filtered by organization, project, or region.
nscale object-storage list [flags]

Flags

FlagDescription
—org stringOrganization ID
—project stringProject ID
—region stringRegion ID
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq filter for value extraction (see Query output with -q)

Example

nscale object-storage list --org <org-id> --region <region-id>

get

Get details for a specific object storage endpoint.
nscale object-storage get --id <endpoint-id> --org <org-id>

Flags

FlagDescription
—id stringObject storage endpoint ID
—org stringOrganization ID
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq filter for value extraction (see Query output with -q)

create

Create a new object storage endpoint. Accepts input from a JSON file or stdin.
nscale object-storage create [flags]

Flags

FlagDescription
-f, —file stringPath to a JSON file
—stdinRead JSON from standard input
—dry-runPreview the request payload without persisting
-y, —yesAutomatically confirm creation
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq filter for value extraction (see Query output with -q)

Examples

nscale object-storage create --file endpoint.json
nscale object-storage create --stdin < endpoint.json
cat endpoint.json | nscale object-storage create --stdin

delete

Delete an existing object storage endpoint.
nscale object-storage delete --id <endpoint-id> --org <org-id> [flags]

Flags

FlagDescription
--id stringObject storage endpoint ID
--org stringOrganization ID
--dry-runPreview the request payload without persisting
-y, --yesAutomatically confirm deletion

Example

nscale object-storage delete --id <endpoint-id> --org <org-id> --yes

list-policies

List identity policies for an object storage endpoint.
nscale object-storage list-policies --id <endpoint-id> --org <org-id>

Flags

FlagDescription
—id stringObject storage endpoint ID
—org stringOrganization ID
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq 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.
nscale object-storage get-policy-document --id <endpoint-id> --name <policy-name> --org <org-id>

Flags

FlagDescription
—id stringObject storage endpoint ID
—name stringIdentity policy name
—org stringOrganization ID
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq 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.
nscale object-storage create-policy --id <endpoint-id> --name <policy-name> [flags]

Flags

FlagDescription
—id stringObject storage endpoint ID
—name stringIdentity policy name
—org stringOrganization ID
-f, —file stringPath to a JSON policy document file
—stdinRead JSON from standard input
—dry-runPreview the request payload without persisting
-y, —yesAutomatically confirm creation
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq filter for value extraction (see Query output with -q)

Examples

nscale object-storage create-policy --id <endpoint-id> --name read-only --file policy.json
cat policy.json | nscale object-storage create-policy --id <endpoint-id> --name read-only --stdin

update-policy

Update an existing identity policy on an object storage endpoint. The policy document is read from a JSON file or stdin.
nscale object-storage update-policy --id <endpoint-id> --name <policy-name> [flags]

Flags

FlagDescription
—id stringObject storage endpoint ID
—name stringIdentity policy name
—org stringOrganization ID
-f, —file stringPath to a JSON policy document file
—stdinRead JSON from standard input
—dry-runPreview the request payload without persisting
-y, —yesAutomatically confirm update
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq filter for value extraction (see Query output with -q)

Examples

nscale object-storage update-policy --id <endpoint-id> --name read-only --file policy.json
cat policy.json | nscale object-storage update-policy --id <endpoint-id> --name read-only --stdin

delete-policy

Delete an identity policy from an object storage endpoint.
nscale object-storage delete-policy --id <endpoint-id> --name <policy-name> --org <org-id> [flags]

Flags

FlagDescription
--id stringObject storage endpoint ID
--name stringIdentity policy name
--org stringOrganization ID
--dry-runPreview the request payload without persisting
-y, --yesAutomatically confirm deletion

Example

nscale object-storage delete-policy --id <endpoint-id> --name read-only --org <org-id> --yes

list-access-keys

List access keys for an object storage endpoint.
nscale object-storage list-access-keys --id <endpoint-id> --org <org-id>

Flags

FlagDescription
—id stringObject storage endpoint ID
—org stringOrganization ID
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq 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.
nscale object-storage create-access-key --id <endpoint-id> --name <key-name> [flags]

Flags

FlagDescription
—id stringObject storage endpoint ID
—name stringAccess key name
—policy stringIdentity policy name to associate with the access key
—org stringOrganization ID
—dry-runPreview the request payload without persisting
-y, —yesAutomatically confirm creation
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq filter for value extraction (see Query output with -q)

Example

nscale object-storage create-access-key --id <endpoint-id> --name my-key --policy read-only

delete-access-key

Delete an access key from an object storage endpoint.
nscale object-storage delete-access-key --id <endpoint-id> --access-key-id <access-key-id> --org <org-id> [flags]

Flags

FlagDescription
--id stringObject storage endpoint ID
--access-key-id stringAccess key ID
--org stringOrganization ID
--dry-runPreview the request payload without persisting
-y, --yesAutomatically confirm deletion

Example

nscale object-storage delete-access-key --id <endpoint-id> --access-key-id <access-key-id> --org <org-id> --yes

Object Storage (Console)

Create and manage object storage via the Console UI.