---
title: Update a bucket
description: Changes the name, permission, availability, or policy atomically.
doc_version: 0.1.0-preview
last_updated: 2026-09-14
---

# Update a bucket

`PATCH /v1/workspaces/{workspaceId}/buckets/{bucketId}`

Changes the name, permission, availability, or policy atomically. Send the current revision as a quoted If-Match header. Names are case-sensitive and unique within the workspace. Renaming preserves the bucket ID and stored objects. Update S3 paths after renaming. A missing field keeps its value. Role: editor or higher.

## Authentication

Send `Authorization: Bearer <GRAPHON_API_KEY>`. Read the key from the
GRAPHON_API_KEY environment variable. Never print it.

## Path parameters

- `workspaceId` (string) — The workspace id.
- `bucketId` (string) — The bucket id.

## Headers

- `if-match` (string (optional)) — Required. The current bucket revision in quotes, for example "3". A missing revision returns 428. A stale revision returns 412.

## Request body

- `name` (string (optional)) — A case-sensitive name unique within this workspace. Use 1 to 255 ASCII letters, digits, periods, underscores, or hyphens. The exact names . and .. are invalid.
- `permission` (string (optional)) — Who can read objects: private, or public-read for anonymous GET and HEAD. One of: private, public-read.
- `availability` (string (optional)) — An offline bucket rejects reads and writes. One of: online, offline.
- `policy` (object (optional)) — Bucket policy settings, such as versioning and retention.

## Example request

```bash
curl --request PATCH \
  --url "https://storage.beta.graphon.sh/v1/workspaces/wspq7ws2np5l8z4/buckets/bktA1b2C3d4E5" \
  --header 'if-match: "3"' \
  --header "Authorization: Bearer $GRAPHON_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"name":"Support.Tickets_2026"}'
```

## CLI

```bash
graphon buckets update support-tickets --permission public-read
```

## Example response

```json
{
  "id": "bktA1b2C3d4E5",
  "workspaceId": "wspq7ws2np5l8z4",
  "name": "support-tickets",
  "provider": "gcp",
  "location": "us-central1",
  "storageClass": "standard",
  "permission": "private",
  "phase": "active",
  "availability": "online",
  "indexing": "enabled",
  "objectCount": 12,
  "revision": 1,
  "createdAt": "2026-10-01T12:00:00.000Z",
  "policy": {}
}
```

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.