Sign in

v3

latestOpenAPI 3.1.02026-08-0755220214.3 KB
externalStoragePolicies

Update

Updates an external storage policy by name or ID. Credentials can only be rotated by providing both access_key_id and secret_access_key.

patch/external_storage_policies/{nameOrId}

Path parameters

nameOrIdstring required

The name or the ID of the external storage policy to update.

Query parameters

projectstring

The name of the project containing the external storage policy. Only used when nameOrId is a name.

Headers

Authorizationstring required

Bearer authentication header of the form Bearer <PHONIC_API_KEY>. Manage your API keys here.

Request body

namestring

The name of the external storage policy. Must be snake_case, start with a lowercase letter and be unique within the project.

endpoint_urlstring

The S3-compatible endpoint URL that artifacts are uploaded to. Must be a publicly routable HTTPS URL without embedded credentials.

bucketstring

The bucket that artifacts are uploaded to.

regionstring nullable

The region of the bucket. Set to null when the endpoint doesn't require a region.

key_prefixstring nullable

Prefix prepended to every object key.

addressing_style'auto' | 'virtual' | 'path'

How bucket names are addressed in requests to the endpoint.

access_key_idstring

Access key ID used to authenticate with the endpoint. Must be provided together with secret_access_key.

secret_access_keystring

Secret access key used to authenticate with the endpoint. Must be provided together with access_key_id.

Response

Success response

successboolean required

Whether the external storage policy was updated successfully.