GRgroundxai
Buckets

update

Changed on

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.

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

Path parameters

bucketIdinteger required

The bucketId of the bucket being updated.

Request body

newNamestring required

The new name of the bucket being renamed.

Example request

{
  "newName": "your_bucket_name"
}

Response

Bucket successfully updated

Changes

  • 3bb565058636Revision changes
    • breaking

      added the new required request property

    • warning

      removed the request property

  • 43657b55255eRevision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status