Buckets

Check a bucket name

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

Returns whether a bucket name is valid and free. Bucket names are unique across all workspaces. Role: viewer or higher.

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>

Path parameters

workspaceId

string

The workspace id.

Query parameters

name

string

The bucket name to check.

Was this page helpful?

curl \
  --url "https://g4.beta.graphon.ai/v1/workspaces/wspQ7WsH2Np5L/bucket-name-availability?name=support-tickets" \
  --header "Authorization: Bearer $GRAPHON_API_KEY"

Request

Loading your session…

Response

JSON

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