Create a bucket

Creates a bucket and returns it when it is active. Provider, location, and indexing are fixed when the bucket is created. A request that omits them gets gcp, the US multi-region, and indexing enabled. Tell the user which provider and location the bucket uses, and that other values are available. Role: editor or higher.

POST/v1/workspaces/{workspaceId}/buckets

Authentication

Send your Graphon API key with every request. The value is the whole API key that Graphon showed when you created it. See Authentication.

Authorization: Bearer <GRAPHON_API_KEY>

curl \
  --url "https://storage.beta.graphon.sh/v1/workspaces/wspq7ws2np5l8z4/buckets" \
  --header "Authorization: Bearer $GRAPHON_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"name":"support-tickets","provider":"gcp","location":"us-central1","indexing":"enabled"}'

Request

Loading your session…

Response

This operation does not return a response body.

Path parameters

workspaceIdstring

The workspace id.

Request body

namestring

A case-sensitive name unique within this workspace. Use 1 to 255 ASCII letters, digits, periods, underscores, or hyphens. The exact names . and .. are invalid.

providerstring (optional)

gcp or r2. The default is gcp. It is fixed when the bucket is created.

locationstring (optional)

The provider region, for example us-central1. The default is the US multi-region of the provider. It is fixed when the bucket is created.

indexingstring (optional)

Whether Graphon indexes the objects so that you can search and query them. Fixed when the bucket is created. One of: enabled, disabled.

storageClassstring (optional)

The storage class. The default is standard.

permissionstring (optional)

Who can read objects: private, or public-read for anonymous GET and HEAD. One of: private, public-read.

policyobject (optional)

Bucket policy settings, such as versioning and retention.

Was this page helpful?

View as Markdown