---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Buckets"
description: "The `buckets` collection of Sylphx Data: A Bucket is one customer object store: bytes, size, and SHA-256 kept exact, with versions, delete markers, retention, multipart, and per-object visibility (private by default)."
type: reference
product: storage
summary: "A Bucket is one customer object store: bytes, size, and SHA-256 kept exact, with versions, delete markers, retention, multipart, and…"
updated: 2026-09-28
order: 900
---

A Bucket is one customer object store: bytes, size, and SHA-256 kept exact, with versions, delete markers, retention, multipart, and per-object visibility (private by default). Silo: each has its own engine, credentials, backup, region, and deletion.

**Service** Sylphx Data · **Resource type** `data.sylphx.com/Bucket` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/buckets/{bucket}` · **Shape** `spec_status`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/buckets/{bucket}`. |
| `uid` | `string` | `bkt_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `BucketSpec` | Desired state. Required. |
| `status` | `BucketStatus` | Observed state. Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/buckets#get) | Gets a bucket. |
| `GET` | [`list`](/docs/api/buckets#list) | Lists buckets in a environment. |
| `POST` | [`create`](/docs/api/buckets#create) | Creates a bucket. The Operation is done when the controller settles it. |
| `PATCH` | [`update`](/docs/api/buckets#update) | Updates a bucket. |
| `DELETE` | [`delete`](/docs/api/buckets#delete) | Deletes a bucket. Fails while `spec.deletion_protection` is set. |
| `POST` | [`connect`](/docs/api/buckets#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. |
| `POST` | [`rotate_credentials`](/docs/api/buckets#rotate-credentials) | Replaces the bucket's engine credentials; the old ones stop working once the new ones are served. |

## get

Gets a 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.

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

## create

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

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

## update

Updates a bucket.

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

## delete

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

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

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

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

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