---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "sylphx data buckets"
description: "The sylphx data buckets commands of Sylphx Data: every verb, with its argument, its flags and a run line."
type: reference
product: storage
summary: "Every sylphx data buckets command: its argument, its flags and a run line."
updated: 2026-09-28
nav: false
---

The `buckets` commands of Sylphx Data, as the CLI spells them: the same
calls as [the `buckets` API page](/docs/api/buckets), typed for the
shell. [Install, sign in and the grammar](/docs/cli) are on the CLI index.

## get

Gets a bucket.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx data buckets get orgs/acme/projects/shop/envs/production/buckets/bucket
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets/bucket` · scope `data:read` · effect `read` · [Request, response and examples](/docs/api/buckets/get)

## list

Lists buckets in a environment.

**`PARENT`** — optional: the CLI fills it from the linked project or the
key's scope when it is left out.

**CLI**

```bash
sylphx data buckets list orgs/acme/projects/shop/envs/production
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets` · scope `data:read` · effect `read` · [Request, response and examples](/docs/api/buckets/list)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--page-size` | `int` | At most this many; default 50, clamped to 1000. |
| `--page-token` | `string` | `next_page_token` of the previous page. |
| `--filter` | `string` | AIP-160 filter over labels, filterable fields, and Ready. |
| `--order-by` | `string` | AIP-132 ordering over filterable fields. |

## create

Creates a bucket. The Operation is done when the controller settles it.

**`ID`** — The id segment of the new Resource's name; the server assigns one when omitted.

**CLI**

```bash
sylphx data buckets create --parent orgs/acme/projects/shop/envs/production
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets` · scope `data:write` · effect `write` · [Request, response and examples](/docs/api/buckets/create)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--parent` | `string` | The parent to create in; defaults to the linked project or the key's scope. |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--spec.versioning-enabled` | `bool` | Keep every version and write delete markers. |
| `--spec.retention` | `duration` | Versions are kept at least this long; unset keeps no minimum. |
| `--spec.region` | `string` | The region; default the project's home region. Changing it moves the data by signed export and import. |
| `--spec.deletion-protection` | `bool` | While set, Delete fails with DELETION_PROTECTED. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |

## update

Updates a bucket.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx data buckets update orgs/acme/projects/shop/envs/production/buckets/bucket
```

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets/bucket` · scope `data:write` · effect `write` · [Request, response and examples](/docs/api/buckets/update)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--spec.versioning-enabled` | `bool` | Keep every version and write delete markers. |
| `--spec.retention` | `duration` | Versions are kept at least this long; unset keeps no minimum. |
| `--spec.region` | `string` | The region; default the project's home region. Changing it moves the data by signed export and import. |
| `--spec.deletion-protection` | `bool` | While set, Delete fails with DELETION_PROTECTED. |
| `--allow-missing` | `bool` | Create the Resource when it does not exist (declarative upsert). |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |

## delete

Deletes a bucket. Fails while `spec.deletion_protection` is set.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx data buckets delete orgs/acme/projects/shop/envs/production/buckets/bucket --yes
```

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets/bucket` · scope `data:write` · effect `destructive` · [Request, response and examples](/docs/api/buckets/delete)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--etag` | `string` | Delete only if the current etag matches. |
| `--allow-missing` | `bool` | Succeed when the Resource does not exist. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |
| `--yes` | `bool` | Do not ask before this destructive call. |

## connect

Returns how to connect to the bucket: its endpoint and its own engine credentials. The credentials are not API keys and are returned only here.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx data buckets connect orgs/acme/projects/shop/envs/production/buckets/bucket
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets/bucket:connect` · scope `data:write` · effect `read` · [Request, response and examples](/docs/api/buckets/connect)

## rotate-credentials

Replaces the bucket's engine credentials; the old ones stop working once the new ones are served.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx data buckets rotate-credentials orgs/acme/projects/shop/envs/production/buckets/bucket
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets/bucket:rotateCredentials` · scope `data:write` · effect `write` · [Request, response and examples](/docs/api/buckets/rotate_credentials)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--etag` | `string` | Act only if the current etag matches. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |