PATCH /v1/buckets/{bucketId} | Update bucket

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`.

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

AuthorizationBearer <token>

OAuth2 authentication

In: header

Scope: workspace:admin, offline_access

Path Parameters

bucketId*string

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

displayName?string

New display name for the bucket. A label only: the provider bucket name does not change.

Length1 <= length <= 100

branchId?string

ID of the branch to move the bucket to. Mutually exclusive with branchGitName.

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

branchGitName?string

Git name of the branch to move the bucket to; the branch is created when it does not exist. Mutually exclusive with branchId.

Length1 <= length

logicalId?|

Declared identity of the resource, unique within its branch. Set by the tool that declares the resource. Send null to clear the logical id.

Match^[A-Za-z0-9][A-Za-z0-9._-]*$

Lengthlength <= 255

Response Body

`application/json`

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

Update bucket

Authorization

Path Parameters

Request Body

Response Body

200application/json

401application/json

404application/json

409application/json

413application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`