Check a bucket name

Returns whether a bucket name is valid and free. Names are case-sensitive and unique within this workspace. Role: viewer or higher.

GET/v1/workspaces/{workspaceId}/bucket-name-availability

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.graphon.sh/v1/workspaces/wspq7ws2np5l8z4/bucket-name-availability?name=support-tickets" \
  --header "Authorization: Bearer $GRAPHON_API_KEY"

Request

Loading your session…

Response

JSON

{
  "available": true,
  "reason": null
}

Path parameters

workspaceIdstring

The workspace id.

Query parameters

namestring

The bucket name to check.

Was this page helpful?

View as Markdown