---
title: "Update a bucket"
method: PATCH
path: "/app/{appId}/bucket/{bucketId}"
tags: ["buildDistro"]
---

# Update a bucket

`PATCH /app/{appId}/bucket/{bucketId}`

## Request

- Base URL: `https://api.runway.team`
- URL: `https://api.runway.team/app/{appId}/bucket/{bucketId}`
- Auth: API key in header `X-API-Key`

## Path parameters

- `appId` string, required
- `bucketId` string, required

## Request body

- object
  - `name` string: The name of the bucket
  - `status` 'active' | 'archived': Status of a Build Distro bucket
  - `orgWideAccessEnabled` boolean: Whether or not the bucket should have org-wide access enabled
  - `notificationsEnabled` boolean: Whether or not the bucket should have notifications enabled
  - `rules` BucketRule[]
    - `type` string, required: The type of rule
    - `fileFilterPatterns` string[], required: The patterns to match files on
    - `branch` string: The branch to match on. You should only set this value on `branch` rules.
    - `baseBranch` string: The target branch for Pull Requests to match on. You should only set this value on `pr` rules.
    - `workflowId` string: The Id for the workflow associated with this rule.
  - `members` BucketMember[]
    - `type` 'user' | 'userGroup', required: The type of tester
    - `id` string, required: The ID of the user or user group
  - `notifications` NotificationEntity[]
    - `type` string, required
    - `enabled` boolean, required
  - `automations` AutomationEntity[]
    - `type` string, required
    - `enabled` boolean, required

## Response `200`

A Build Distro bucket response

- BuildDistroBucketEntity
  - `id` string, required: The id of the Build Distro bucket
  - `name` string, required: The name of the bucket
  - `type` 'custom' | 'personal' | 'rc' | 'dev', required: Type of a Build Distro bucket
  - `rules` BucketRule, required
    - `type` string, required: The type of rule
    - `fileFilterPatterns` string[], required: The patterns to match files on
    - `branch` string: The branch to match on. You should only set this value on `branch` rules.
    - `baseBranch` string: The target branch for Pull Requests to match on. You should only set this value on `pr` rules.
    - `workflowId` string: The Id for the workflow associated with this rule.
  - `members` BucketMember[], required: The members of the bucket
    - `type` 'user' | 'userGroup', required: The type of tester
    - `id` string, required: The ID of the user or user group
  - `orgWideAccessEnabled` boolean, required: Whether or not the bucket has org-wide access enabled
  - `status` 'active' | 'archived', required: Status of a Build Distro bucket
  - `notificationsEnabled` boolean, required: Whether or not the bucket has notifications enabled
  - `notifications` NotificationEntity[], required: The notifications for the bucket
    - `type` string, required
    - `enabled` boolean, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `automations` AutomationEntity[], required: The automations for the bucket
    - `type` string, required
    - `enabled` boolean, required
  - `archivedAt` string, date-time
  - `totalBuildsCount` integer, required: The total count of builds in the bucket

## Other responses

- `404`: Resource not found response

---

[API](https://skmtc.dev/runway/apis/runway-rest-api.md) - [All operations](https://skmtc.dev/runway/apis/runway-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/runway/apis/runway-rest-api/revisions/081109863a9a?raw)