Update a BYO storage bucket

PUT

/v1/storage-buckets/{bucket_id}

Authorizations

• HTTPBearer
• HTTPBearer
  API_STORAGE

Parameters

Path Parameters

bucket_id

required

Bucket Id

string format: uuid

Request Body^required

UpdateStorageBucketRequest

object

name

Any of:

string

string

null

null

provider

Any of:

StorageBucketProvider

StorageBucketProvider

Supported object store. Amazon S3 only today. Cloudflare R2, MinIO, and other S3-compatible stores are coming soon.

string

Allowed values: S3

null

null

auth_mode

Any of:

StorageBucketAuthMode

StorageBucketAuthMode

Amazon S3 uses OIDC (AssumeRoleWithWebIdentity). Static access keys are not supported for S3.

string

Allowed values: OIDC

null

null

region

Any of:

string

string

null

null

bucket_name

Any of:

string

string

null

null

endpoint_url

Any of:

string

string

null

null

sts_endpoint_url

Any of:

string

string

null

null

key_prefix

Any of:

string

string

null

null

role_arn

Any of:

string

string

null

null

external_id

Any of:

string

string

null

null

oidc_audience

Any of:

string

string

null

null

access_key_id

Any of:

string

string

null

null

secret_access_key

Any of:

string

string

null

null

is_default

Any of:

boolean

boolean

null

null

Responses

200

Successful Response

StorageBucket

object

id

required

Id

string

name

required

Name

string

provider

required

StorageBucketProvider

Supported object store. Amazon S3 only today. Cloudflare R2, MinIO, and other S3-compatible stores are coming soon.

string

Allowed values: S3

auth_mode

StorageBucketAuthMode

Amazon S3 uses OIDC (AssumeRoleWithWebIdentity). Static access keys are not supported for S3.

string

default: OIDC

Allowed values: OIDC

region

required

Region

string

bucket_name

required

Bucket Name

string

endpoint_url

Any of:

string

string

null

null

sts_endpoint_url

Any of:

string

string

null

null

key_prefix

Key Prefix

string

""

role_arn

Any of:

string

string

null

null

oidc_subject

Any of:

string

string

null

null

oidc_audience

Any of:

string

string

null

null

access_key_id

Any of:

string

string

null

null

has_secret_access_key

Has Secret Access Key

boolean

status

required

Status

string

is_default

required

Is Default

boolean

dependent_repository_count

Dependent Repository Count

integer

0

last_validated_at

Any of:

string

string

null

null

created_at

Any of:

string

string

null

null

403

Forbidden

GenericError

object

detail

Detail

404

Not Found

GenericError

object

detail

Detail

422

Unprocessable Entity

GenericError

object

detail

Detail