Buckets

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}

Request

  • Base URL: https://api.prisma.io
  • URL: https://api.prisma.io/v1/buckets/{bucketId}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://auth.prisma.io/authorize, token URL https://auth.prisma.io/token, scopes: workspace:admin, offline_access)
    • HTTP bearer

Path parameters

bucketIdstring required

Request body

displayNamestring

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

branchIdstring

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

branchGitNamestring

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

logicalIdstring nullable

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

Response

Updated the bucket.

Changes

No recorded changes to this operation across all 1 revision of this API.