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.

AuthorizationBearer <token>

OAuth2 authentication

In: header

Scope: workspace:admin, offline_access

bucketId*string

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

application/json

TypeScript Definitions

Use the request body type in TypeScript.

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

{
  "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"
  }
}