---
title: Check a bucket name
description: Returns whether a bucket name is valid and free.
doc_version: 0.1.0-preview
last_updated: 2026-09-14
---

# 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 `Authorization: Bearer <GRAPHON_API_KEY>`. Read the key from the
GRAPHON_API_KEY environment variable. Never print it.

## Path parameters

- `workspaceId` (string) — The workspace id.

## Query parameters

- `name` (string) — The bucket name to check.

## Example request

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

## CLI

```bash
graphon buckets availability --name support-tickets
```

## Example response

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

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.