---
title: "update"
method: PUT
path: "/v1/bucket/{bucketId}"
tags: ["Buckets"]
---

# update

`PUT /v1/bucket/{bucketId}`

## Request

- Base URL: `https://api.groundx.ai/api`
- URL: `https://api.groundx.ai/api/v1/bucket/{bucketId}`
- Auth: API key in header `X-API-Key`

Rename a bucket.

Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.

## Path parameters

- `bucketId` integer, required

## Request body

- BucketUpdateRequest
  - `newName` string, required: The new name of the bucket being renamed.

## Response `200`

Bucket successfully updated

- BucketUpdateResponse
  - `bucket` BucketUpdateDetail, required
    - `bucketId` integer, required
    - `name` string

## Other responses

- `400`: Invalid body parameter
- `401`: Unauthorized to update bucket with given ID

## Changes

- **2023-11-29** `3bb565058636`: 1 breaking, 1 warning
  - added the new required request property `newName`
  - removed the request property `bucket`
- **2023-10-13** `43657b55255e`: 2 warning
  - removed the optional property `bucket/fileCount` from the response with the `200` status
  - removed the optional property `bucket/fileSize` from the response with the `200` status
- **2023-10-09** `50642c47d873`: 1 breaking
  - the request property `bucket/name` became required
- **2023-10-05** `5ee59ea914aa`: 2 info
  - api tag `Buckets` added
  - api tag `Bucket` removed
- **2023-10-05** `006f5c1a8d40`: 1 info
  - the response property `bucket/bucketId` became required for the status `200`

[Operation history](https://skmtc.dev/groundxai/apis/groundx-apis/changes/v1/bucket/:bucketId/put.md)

---

[API](https://skmtc.dev/groundxai/apis/groundx-apis.md) - [All operations](https://skmtc.dev/groundxai/apis/groundx-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/groundxai/apis/groundx-apis/revisions/1c1a5c17f52f?raw)