> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nscale.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Object storage

> Manage object storage endpoints, identity policies, and access keys.

**Aliases:** `object-storage`, `os`

Commands 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.

> [!NOTE]
>
> 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) — List object storage endpoints
* [classes](#classes) — List object storage endpoint classes
* [get](#get) — Get object storage endpoint details
* [create](#create) — Create a new object storage endpoint
* [delete](#delete) — Delete an object storage endpoint

**Identity policies** (aliases: `policy`, `policies`)

* [policy list](#policy-list) — List identity policies for an endpoint
* [policy get-document](#policy-get-document) — Show the JSON policy document for an identity policy
* [policy create](#policy-create) — Create a new identity policy on an endpoint
* [policy update](#policy-update) — Update an existing identity policy
* [policy delete](#policy-delete) — Delete an identity policy from an endpoint

**Access keys** (aliases: `access-key`, `access-keys`)

* [access-key list](#access-key-list) — List access keys for an endpoint
* [access-key create](#access-key-create) — Create a new access key for an endpoint
* [access-key delete](#access-key-delete) — Delete an access key from an endpoint

***

## list

List object storage endpoints, optionally filtered by organization, project, or region.

```bash theme={null}
nscale object-storage list [flags]
```

### Flags

<table>
  <thead><tr><th>Flag</th><th>Description</th></tr></thead>

  <tbody>
    <tr><td>`--org string`</td><td>Organization ID or name</td></tr>
    <tr><td>`--project string`</td><td>Project ID or name</td></tr>
    <tr><td>`--region string`</td><td>Region ID or name</td></tr>

    <tr>
      <td>
        `--limit int`
      </td>

      <td>Show at most N results (client-side; every result is still fetched). Cuts before `-q`. `0` for all</td>
    </tr>

    <tr>
      <td>
        `--json`
      </td>

      <td>Emit the full JSON payload (mutually exclusive with `-q`)</td>
    </tr>

    <tr>
      <td>
        `-q, --query stringArray`
      </td>

      <td>jq filter for value extraction (see [Query output with `-q`](https://docs.nscale.com/docs/cli/query-output))</td>
    </tr>
  </tbody>
</table>

### Example

```bash theme={null}
nscale object-storage list --org <org-id> --region <region-id>
```

***

## 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](#create) an endpoint. The table shows each class's ID, name, region, and endpoint types.

```bash theme={null}
nscale object-storage classes [flags]
```

### Flags

<table>
  <thead><tr><th>Flag</th><th>Description</th></tr></thead>

  <tbody>
    <tr><td>`--org string`</td><td>Organization ID or name</td></tr>
    <tr><td>`--region string`</td><td>Region ID or name (defaults to all regions)</td></tr>

    <tr>
      <td>
        `--limit int`
      </td>

      <td>Show at most N results (client-side; every result is still fetched). Cuts before `-q`. `0` for all</td>
    </tr>

    <tr>
      <td>
        `--json`
      </td>

      <td>Emit the full JSON payload (mutually exclusive with `-q`)</td>
    </tr>

    <tr>
      <td>
        `-q, --query stringArray`
      </td>

      <td>jq filter for value extraction (see [Query output with `-q`](https://docs.nscale.com/docs/cli/query-output))</td>
    </tr>
  </tbody>
</table>

### Examples

```bash theme={null}
nscale object-storage classes --region <region-id>
nscale object-storage classes --region <region-id> -q '.[].metadata.id'
```

***

## get

Get details for a specific object storage endpoint.

```bash theme={null}
nscale object-storage get <endpoint-id> --org <org-id>
```

### Flags

<table>
  <thead><tr><th>Flag</th><th>Description</th></tr></thead>

  <tbody>
    <tr><td>`--id string`</td><td>Object storage endpoint ID or name. Can also be passed as a positional argument</td></tr>
    <tr><td>`--org string`</td><td>Organization ID or name</td></tr>

    <tr>
      <td>
        `--json`
      </td>

      <td>Emit the full JSON payload (mutually exclusive with `-q`)</td>
    </tr>

    <tr>
      <td>
        `-q, --query stringArray`
      </td>

      <td>jq filter for value extraction (see [Query output with `-q`](https://docs.nscale.com/docs/cli/query-output))</td>
    </tr>
  </tbody>
</table>

***

## 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.

```bash theme={null}
nscale object-storage create [flags]
```

### Flags

<table>
  <thead><tr><th>Flag</th><th>Description</th></tr></thead>

  <tbody>
    <tr><td>`-f, --file string`</td><td>Path to a JSON file</td></tr>
    <tr><td>`--stdin`</td><td>Read JSON from standard input</td></tr>
    <tr><td>`--dry-run`</td><td>Preview actions and payload without persisting</td></tr>
    <tr><td>`-y, --yes`</td><td>Automatically confirm creation</td></tr>
    <tr><td>`--wait`</td><td>Block until provisioning finishes. Without it, the command returns as soon as the request is accepted</td></tr>
    <tr><td>`--wait-timeout duration`</td><td>How long `--wait` polls before giving up. The operation keeps running server-side (default `30m0s`)</td></tr>

    <tr>
      <td>
        `--json`
      </td>

      <td>Emit the full JSON payload (mutually exclusive with `-q`)</td>
    </tr>

    <tr>
      <td>
        `-q, --query stringArray`
      </td>

      <td>jq filter for value extraction (see [Query output with `-q`](https://docs.nscale.com/docs/cli/query-output))</td>
    </tr>
  </tbody>
</table>

### Examples

```bash theme={null}
nscale object-storage create --file endpoint.json
nscale object-storage create --stdin < endpoint.json
nscale object-storage create --file endpoint.json --yes --wait
```

***

## 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.

```bash theme={null}
nscale object-storage delete <endpoint-id> --org <org-id> [flags]
```

**Aliases:** `delete`, `rm`, `remove`

### Flags

| Flag | Description |
| - | - |
| `--id string` | Object storage endpoint ID or name. Can also be passed as a positional argument |
| `--org string` | Organization ID or name |
| `--dry-run` | Preview actions and payload without persisting |
| `-y, --yes` | Automatically confirm deletion |
| `--wait` | Block until deletion finishes |
| `--wait-timeout duration` | How long `--wait` polls before giving up. The operation keeps running server-side (default `30m0s`) |

### Examples

```bash theme={null}
nscale object-storage delete <endpoint-id> --org <org-id> --yes
nscale object-storage delete <endpoint-id> --yes --wait
```

***

## policy list

List identity policies for an object storage endpoint.

```bash theme={null}
nscale object-storage policy list <endpoint-id> --org <org-id>
```

### Flags

<table>
  <thead><tr><th>Flag</th><th>Description</th></tr></thead>

  <tbody>
    <tr><td>`--id string`</td><td>Object storage endpoint ID or name. Can also be passed as a positional argument</td></tr>
    <tr><td>`--org string`</td><td>Organization ID or name</td></tr>

    <tr>
      <td>
        `--limit int`
      </td>

      <td>Show at most N results (client-side; every result is still fetched). Cuts before `-q`. `0` for all</td>
    </tr>

    <tr>
      <td>
        `--json`
      </td>

      <td>Emit the full JSON payload (mutually exclusive with `-q`)</td>
    </tr>

    <tr>
      <td>
        `-q, --query stringArray`
      </td>

      <td>jq filter for value extraction (see [Query output with `-q`](https://docs.nscale.com/docs/cli/query-output))</td>
    </tr>
  </tbody>
</table>

***

## policy get-document

Show the JSON policy document for an identity policy on an object storage endpoint.

```bash theme={null}
nscale object-storage policy get-document <endpoint-id> --name <policy-name> --org <org-id>
```

### Flags

<table>
  <thead><tr><th>Flag</th><th>Description</th></tr></thead>

  <tbody>
    <tr><td>`--id string`</td><td>Object storage endpoint ID or name. Can also be passed as a positional argument</td></tr>
    <tr><td>`--name string`</td><td>Identity policy name</td></tr>
    <tr><td>`--org string`</td><td>Organization ID or name</td></tr>

    <tr>
      <td>
        `--json`
      </td>

      <td>Emit the full JSON payload (mutually exclusive with `-q`)</td>
    </tr>

    <tr>
      <td>
        `-q, --query stringArray`
      </td>

      <td>jq filter for value extraction (see [Query output with `-q`](https://docs.nscale.com/docs/cli/query-output))</td>
    </tr>
  </tbody>
</table>

***

## policy create

Create a new identity policy on an object storage endpoint. The policy document is read from a JSON file or stdin.

```bash theme={null}
nscale object-storage policy create <endpoint-id> --name <policy-name> [flags]
```

### Flags

<table>
  <thead><tr><th>Flag</th><th>Description</th></tr></thead>

  <tbody>
    <tr><td>`--id string`</td><td>Object storage endpoint ID or name. Can also be passed as a positional argument</td></tr>
    <tr><td>`--name string`</td><td>Identity policy name</td></tr>
    <tr><td>`--org string`</td><td>Organization ID or name</td></tr>
    <tr><td>`-f, --file string`</td><td>Path to a JSON policy document file</td></tr>
    <tr><td>`--stdin`</td><td>Read JSON from standard input</td></tr>
    <tr><td>`--dry-run`</td><td>Preview actions and payload without persisting</td></tr>
    <tr><td>`-y, --yes`</td><td>Automatically confirm creation</td></tr>

    <tr>
      <td>
        `--json`
      </td>

      <td>Emit the full JSON payload (mutually exclusive with `-q`)</td>
    </tr>

    <tr>
      <td>
        `-q, --query stringArray`
      </td>

      <td>jq filter for value extraction (see [Query output with `-q`](https://docs.nscale.com/docs/cli/query-output))</td>
    </tr>
  </tbody>
</table>

### Examples

```bash theme={null}
nscale object-storage policy create <endpoint-id> --name read-only --file policy.json
cat policy.json | nscale object-storage policy create <endpoint-id> --name read-only --stdin
```

***

## policy update

Update an existing identity policy on an object storage endpoint. The policy document is read from a JSON file or stdin.

```bash theme={null}
nscale object-storage policy update <endpoint-id> --name <policy-name> [flags]
```

### Flags

<table>
  <thead><tr><th>Flag</th><th>Description</th></tr></thead>

  <tbody>
    <tr><td>`--id string`</td><td>Object storage endpoint ID or name. Can also be passed as a positional argument</td></tr>
    <tr><td>`--name string`</td><td>Identity policy name</td></tr>
    <tr><td>`--org string`</td><td>Organization ID or name</td></tr>
    <tr><td>`-f, --file string`</td><td>Path to a JSON policy document file</td></tr>
    <tr><td>`--stdin`</td><td>Read JSON from standard input</td></tr>
    <tr><td>`--dry-run`</td><td>Preview actions and payload without persisting</td></tr>
    <tr><td>`-y, --yes`</td><td>Automatically confirm update</td></tr>

    <tr>
      <td>
        `--json`
      </td>

      <td>Emit the full JSON payload (mutually exclusive with `-q`)</td>
    </tr>

    <tr>
      <td>
        `-q, --query stringArray`
      </td>

      <td>jq filter for value extraction (see [Query output with `-q`](https://docs.nscale.com/docs/cli/query-output))</td>
    </tr>
  </tbody>
</table>

### Examples

```bash theme={null}
nscale object-storage policy update <endpoint-id> --name read-only --file policy.json
cat policy.json | nscale object-storage policy update <endpoint-id> --name read-only --stdin
```

***

## policy delete

Delete an identity policy from an object storage endpoint.

```bash theme={null}
nscale object-storage policy delete <endpoint-id> --name <policy-name> --org <org-id> [flags]
```

**Aliases:** `delete`, `rm`, `remove`

### Flags

| Flag | Description |
| - | - |
| `--id string` | Object storage endpoint ID or name. Can also be passed as a positional argument |
| `--name string` | Identity policy name |
| `--org string` | Organization ID or name |
| `--dry-run` | Preview actions and payload without persisting |
| `-y, --yes` | Automatically confirm deletion |

### Example

```bash theme={null}
nscale object-storage policy delete <endpoint-id> --name read-only --org <org-id> --yes
```

***

## access-key list

List access keys for an object storage endpoint.

```bash theme={null}
nscale object-storage access-key list <endpoint-id> --org <org-id>
```

### Flags

<table>
  <thead><tr><th>Flag</th><th>Description</th></tr></thead>

  <tbody>
    <tr><td>`--id string`</td><td>Object storage endpoint ID or name. Can also be passed as a positional argument</td></tr>
    <tr><td>`--org string`</td><td>Organization ID or name</td></tr>

    <tr>
      <td>
        `--limit int`
      </td>

      <td>Show at most N results (client-side; every result is still fetched). Cuts before `-q`. `0` for all</td>
    </tr>

    <tr>
      <td>
        `--json`
      </td>

      <td>Emit the full JSON payload (mutually exclusive with `-q`)</td>
    </tr>

    <tr>
      <td>
        `-q, --query stringArray`
      </td>

      <td>jq filter for value extraction (see [Query output with `-q`](https://docs.nscale.com/docs/cli/query-output))</td>
    </tr>
  </tbody>
</table>

***

## access-key create

Create a new access key for an object storage endpoint, optionally associated with an identity policy.

```bash theme={null}
nscale object-storage access-key create <endpoint-id> --name <key-name> [flags]
```

### Flags

<table>
  <thead><tr><th>Flag</th><th>Description</th></tr></thead>

  <tbody>
    <tr><td>`--id string`</td><td>Object storage endpoint ID or name. Can also be passed as a positional argument</td></tr>
    <tr><td>`--name string`</td><td>Access key name</td></tr>
    <tr><td>`--policy string`</td><td>Identity policy name to associate with the access key</td></tr>
    <tr><td>`--org string`</td><td>Organization ID or name</td></tr>
    <tr><td>`--dry-run`</td><td>Preview actions and payload without persisting</td></tr>
    <tr><td>`-y, --yes`</td><td>Automatically confirm creation</td></tr>

    <tr>
      <td>
        `--json`
      </td>

      <td>Emit the full JSON payload (mutually exclusive with `-q`)</td>
    </tr>

    <tr>
      <td>
        `-q, --query stringArray`
      </td>

      <td>jq filter for value extraction (see [Query output with `-q`](https://docs.nscale.com/docs/cli/query-output))</td>
    </tr>
  </tbody>
</table>

### Example

```bash theme={null}
nscale object-storage access-key create <endpoint-id> --name my-key --policy read-only
nscale object-storage access-key create <endpoint-id> --name ci-uploader --policy read-write --yes -q '.spec.accessKeyId' -q '.spec.secret'
```

***

## access-key delete

Delete an access key from an object storage endpoint.

```bash theme={null}
nscale object-storage access-key delete <endpoint-id> --access-key-id <access-key-id> --org <org-id> [flags]
```

**Aliases:** `delete`, `rm`, `remove`

### Flags

| Flag | Description |
| - | - |
| `--id string` | Object storage endpoint ID or name. Can also be passed as a positional argument |
| `--access-key-id string` | Access key ID or name |
| `--org string` | Organization ID or name |
| `--dry-run` | Preview actions and payload without persisting |
| `-y, --yes` | Automatically confirm deletion |

### Example

```bash theme={null}
nscale object-storage access-key delete <endpoint-id> --access-key-id <access-key-id> --org <org-id> --yes
```

***

## Related

> [card] [S3 API (CLI)](https://docs.nscale.com/docs/cli/s3api.md)
>
> Manage buckets and objects inside an endpoint.

> [card] [Object Storage (Console)](https://docs.nscale.com/docs/storage/object-storage.md)
>
> Create and manage object storage via the Console UI.
