Storage

Change visibility (public/private), quota, object limit, CORS rules or the linked project

patch/storage/buckets/{bucketId}

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/storage/buckets/{bucketId}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

bucketIdstring uuid required

Request body

visibility'private' | 'public'

public: every object is readable without credentials at its public URL

quotaBytesinteger
maxObjectsinteger nullable
projectIdstring uuid nullable

null unlinks the bucket from its project

Response

Updated

idstring uuid required
organizationIdstring uuid required
projectIdstring uuid nullable required

the project this bucket belongs to, if any

namestring required

the name you chose, unique in your team

bucketstring required

the S3 bucket name to use with SDKs and tools (globally unique)

visibility'private' | 'public' required

public: every object is readable without credentials at its public URL

status'provisioning' | 'active' | 'deleting' required

deleting: objects are being removed in the background; the bucket and its keys no longer work

endpointstring required

S3 endpoint (path-style addressing), e.g. https://s3.hostingsurge.app

regionstring required

S3 region to sign requests with

publicUrlstring nullable required

base URL of the objects when the bucket is public: <publicUrl><key>

quotaBytesinteger required
maxObjectsinteger nullable required
createdAtstring required

ISO-8601 timestamp

updatedAtstring required

ISO-8601 timestamp

Changes

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