# Update bucket

`PATCH /v1/buckets/{bucketId}`

Updates the display name, logical id, or branch of the bucket with the given ID. The display name is a label only: the provider bucket name, the objects, and the access keys do not change. `logicalId` cannot be combined with `branchId` or `branchGitName` in one request; move the bucket first, then set its `logicalId`.

## [Authorization](#authorization)

AuthorizationBearer \<token>

OAuth2 authentication

In: `header`

Scope: `workspace:admin, offline_access`

## [Path Parameters](#path-parameters)

bucketId\*string

Match`^(bkt_)?([cC][^\s-]{8,}|[a-z0-9]+)$`

## [Request Body](#request-body)

`application/json`

TypeScript Definitions

Use the request body type in TypeScript.

## [Response Body](#response-body)

### `application/json`

### `application/json`

### `application/json`

### `application/json`

### `application/json`

### `application/json`

::::tabs
:::tab{title="cURL"}
```
curl -X PATCH "https://example.com/v1/buckets/string" \
  -H "Content-Type: application/json" \
  -d '{}'
```
:::

:::tab{title="JavaScript"}
```
{
  "data": {
    "id": "string",
    "type": "bucket",
    "url": "http://example.com",
    "name": "string",
    "providerName": "string",
    "status": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "project": {
      "id": "string",
      "url": "http://example.com",
      "name": "string"
    },
    "branchId": "string",
    "logicalId": "string"
  }
}
```
:::

:::tab{title="Go"}
:::

:::tab{title="Python"}
:::

:::tab{title="Java"}
:::

:::tab{title="C#"}
:::

:::tab{title="Rust"}
:::
::::

## Related pages

- [Authentication & Tools](./authentication-tools-index.md)
- [Build](./build-index.md)
- [Changelog](../changelog.md)
- [Concepts](./concepts-index.md)
- [Console commands](./console-commands-index.md)
- [Contract Authoring](./contract-authoring-index.md)
- [Core Concepts](./core-concepts-index.md)
- [Data Modeling](./data-modeling-index.md)
- [Database](./database-index.md)
- [DB commands](./db-commands-index.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.