---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Get a bucket"
description: "`data.buckets.get` (GET /v1/{name}): Gets a bucket."
type: reference
product: storage
summary: "Gets a bucket."
updated: 2026-09-28
nav: false
---

Gets a bucket.

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets/bucket`
- **Scope** `data:read`
- **Effect** `read` — nothing is written.
- **Collection** [buckets](/docs/api/buckets)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the bucket to get. Required. |

## Response

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

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### BucketSpec

| Field | Type | What it is |
| --- | --- | --- |
| `versioning_enabled` | `bool` | Keep every version and write delete markers. |
| `retention` | `duration` | Versions are kept at least this long; unset keeps no minimum. |
| `region` | `string` | The region; default the project's home region. Changing it moves the data by signed export and import. |
| `deletion_protection` | `bool` | While set, Delete fails with DELETION_PROTECTED. |

### BucketStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `state` | `DatastoreState` | Serving state. Output only. One of `provisioning`, `active`, `idle`, `moving`, `deleting`. |
| `ref` | `string` | The routing ref: the first DNS label of the datastore's endpoint. Output only. |
| `host` | `string` | The object endpoint host. Output only. |
| `cell` | `string` | The cell the datastore is placed on. Output only. |
| `storage_bytes` | `int64` | Bytes stored, at the last usage sample. Output only. |
| `object_count` | `int64` | Current objects, at the last usage sample. Output only. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/buckets/bucket" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.data.buckets.get({ name: 'orgs/acme/projects/shop/envs/production/buckets/bucket' })
```

**Rust**

```rust
let mut req = sylphx::data::GetBucketRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/buckets/bucket".to_string();
let response = sx.data().buckets().get(req).await?;
```

**CLI**

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

**Terraform**

```hcl
data "sylphx_data_bucket" "bucket" {
  name = "orgs/acme/projects/shop/envs/production/buckets/bucket"
}
```

**MCP**

```json
{ "method_id": "data.buckets.get", "args": {"name":"orgs/acme/projects/shop/envs/production/buckets/bucket"} }
```